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

package SQL::Translator::Producer::ClassDBI;

# -------------------------------------------------------------------
# $Id: ClassDBI.pm,v 1.23 2003-06-25 19:47:10 kycl4rk 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.23 $ =~ /(\d+)\.(\d+)/;
$DEBUG   = 1 unless defined $DEBUG;

use SQL::Translator::Schema::Constants;
use SQL::Translator::Utils qw(header_comment);
use Data::Dumper;

my %CDBI_auto_pkgs = (
    MySQL      => 'mysql',
    PostgreSQL => 'Pg',
    Oracle     => 'Oracle',
);

# -------------------------------------------------------------------
sub produce {
    my $translator    = shift;
    local $DEBUG      = $translator->debug;
    my $no_comments   = $translator->no_comments;
    my $schema        = $translator->schema;
    my $args          = $translator->producer_args;
    my $db_user       = $args->{'db_user'} || '';
    my $db_pass       = $args->{'db_pass'} || '';
    my $main_pkg_name = $translator->format_package_name('DBI');
    my $header        = header_comment(__PACKAGE__, "# ");
    my $parser_type   = ( split /::/, $translator->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;
    
    #
    # Iterate over all tables
    #
    my ( %packages, $order );
    for my $table ( $schema->get_tables ) {
        my $table_name = $table->name or next;

        my $table_pkg_name = $translator->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 $pk_xform = $translator->format_pk_name ) {
            if ( my $constraint = $table->primary_key ) {
                my $field          = ($constraint->fields)[0];
                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"
                ;
            }
        }
        
        #
        # 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         = $field->foreign_key_reference;
                my $ref_table  = $fk->reference_table;
                my $ref_pkg    = $translator->format_package_name($ref_table);
                my $ref_fld    = 
                    $translator->format_fk_name($ref_table, $field_name);

                push @{ $packages{ $table_pkg_name }{'has_a'} },
                    "$table_pkg_name->has_a(\n".
                    "    $field_name => '$ref_pkg'\n);\n\n".
                    "sub $ref_fld {\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?
                #
                push @{ $packages{ $ref_pkg }{'has_many'} },
                    "$ref_pkg->has_many(\n    '$table_name', ".
                    "'$table_pkg_name' => '$field_name'\n);\n\n"
                ;
            }
        }

        #
        # Identify link tables, defined as tables that 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;
#                }
#            }
#          
#            if ( $is_link ) {
#                foreach my $left ( $table->get_fields ) {
#                    next unless $left->is_foreign_key and $schema->get_table(
#                        $left->foreign_key_reference->reference_table
#                    );
#
#                    next unless $left->is_foreign_key and $schema->get_table(
#                        $left->foreign_key_reference->reference_table
#                    )->get_field(
#                        ($left->foreign_key_reference->reference_fields)[0]
#                    )->is_primary_key;
#              
#                    foreach my $right ( $table->get_fields ) {
#                        #skip the diagonal
#                        next if $left->name eq $right->name;
#
#                        next unless $right->is_foreign_key and 
#                            $schema->get_table(
#                                $right->foreign_key_reference->reference_table
#                            )
#                        ;
#                
#                        next unless $right->is_foreign_key and
#                            $schema->get_table(
#                                $right->foreign_key_reference->reference_table
#                            )->get_field(
#                            ($right->foreign_key_reference->reference_fields)[0]
#                            )->is_primary_key
#                        ;
#                
#                
#                        $linkable{
#                            $left->foreign_key_reference->reference_table
#                        }{
#                            $right->foreign_key_reference->reference_table
#                        } = $table;
#
#                        $linkable{
#                            $right->foreign_key_reference->reference_table
#                        }{
#                            $left->foreign_key_reference->reference_table
#                        } = $table;
#
#                        $linktable{ $table->name } = $table;
#                    }
#                }
#            }
#        }
#
#        #
#        # Generate many-to-many linking methods for data tables
#        #
#        my $is_data = 0;
#        for ( $table->get_fields ) {
#            $is_data++ if !$_->is_foreign_key and !$_->is_primary_key;
#        }
#
#        my %linked;
#        if ( $is_data ) {
#            foreach my $link ( keys %{ $linkable{ $table->name } } ) {
#                my $linkmethodname = 
#                    "_".$translator->format_fk_name($table->name,$link)."_refs"
#                ;
#
#                $create .= $translator->format_package_name($table->name).
#                    "->has_many('$linkmethodname','".
#                    $translator->format_package_name(
#                        $linkable{$table->name}{$link}->name
#                    )."','".
#                    ($schema->get_table($link)->primary_key->fields)[0]."');\n"
#                ;
#
#                $create .= "sub ". $translator->format_fk_name($table,$link).
#                    # HARDCODED 's' HERE.  
#                    # ADD CALLBACK FOR PLURALIZATION MANGLING
#                    "s {\n    my \$self = shift; return map \$_->".$link.
#                    ", \$self->".$linkmethodname.";\n}\n\n"
#                ;
#            }
#        }
    }

    my $base_pkg = sprintf( 'Class::DBI%s', $from ? "::$from" : '' );
    my $create = join("\n",
        "package $main_pkg_name;\n",
        $header,
        "use strict;",
        "use base '$base_pkg';\n",
        "$main_pkg_name->set_db('Main', '$dsn', '$db_user', '$db_pass');\n\n",
    ); 

    for my $pkg_name ( 
        sort { $packages{ $a }{'order'} <=> $packages{ $b }{'order'} }
        keys %packages
    ) {
        my $pkg = $packages{ $pkg_name };

        $create .= join("\n",
            $sep,
            "package ".$pkg->{'pkg_name'}.";",
            "use base '".$pkg->{'base'}."';",
            "use Class::DBI::Pager;\n\n",
        );    

        if ( $from ) {
            $create .= 
                $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",
                $pkg_name."->table('".$pkg->{'table'}."');\n",
                $pkg_name."->columns(All => qw/".
                join(' ', @field_names)."/);\n\n",
            );
        }

        if ( my $pk = $pkg->{'pk_accessor'} ) {
            $create .= $pk;
        }

        if ( my @has_a = @{ $pkg->{'has_a'} || [] } ) {
            $create .= $_ for @has_a;
        }

        if ( my @has_many = @{ $pkg->{'has_many'} || [] } ) {
            $create .= $_ for @has_many;
        }
    }

    $create .= "1;\n";

    return $create;
}

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.org<gt>.
Commit	Line	Data
f42e7027	1	package SQL::Translator::Producer::ClassDBI;
	2
	3	# -------------------------------------------------------------------
d8b3bc7e	4	# $Id: ClassDBI.pm,v 1.23 2003-06-25 19:47:10 kycl4rk Exp $
f42e7027	5	# -------------------------------------------------------------------
5f054727	6	# Copyright (C) 2003 Allen Day <allenday@ucla.edu>,
5f054727	7	# Ying Zhang <zyolive@yahoo.com>
f42e7027	8	#
	9	# This program is free software; you can redistribute it and/or
	10	# modify it under the terms of the GNU General Public License as
	11	# published by the Free Software Foundation; version 2.
	12	#
	13	# This program is distributed in the hope that it will be useful, but
	14	# WITHOUT ANY WARRANTY; without even the implied warranty of
	15	# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
	16	# General Public License for more details.
	17	#
	18	# You should have received a copy of the GNU General Public License
	19	# along with this program; if not, write to the Free Software
	20	# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
	21	# 02111-1307 USA
	22	# -------------------------------------------------------------------
	23
	24	use strict;
	25	use vars qw[ $VERSION $DEBUG ];
d8b3bc7e	26	$VERSION = sprintf "%d.%02d", q$Revision: 1.23 $ =~ /(\d+)\.(\d+)/;
f42e7027	27	$DEBUG = 1 unless defined $DEBUG;
f42e7027	28
6c45056f	29	use SQL::Translator::Schema::Constants;
5ee19df8	30	use SQL::Translator::Utils qw(header_comment);
f42e7027	31	use Data::Dumper;
f42e7027	32
bf4629e7	33	my %CDBI_auto_pkgs = (
	34	MySQL => 'mysql',
	35	PostgreSQL => 'Pg',
	36	Oracle => 'Oracle',
	37	);
	38
	39	# -------------------------------------------------------------------
f42e7027	40	sub produce {
bf4629e7	41	my $translator = shift;
	42	local $DEBUG = $translator->debug;
	43	my $no_comments = $translator->no_comments;
	44	my $schema = $translator->schema;
	45	my $args = $translator->producer_args;
	46	my $db_user = $args->{'db_user'} \|\| '';
	47	my $db_pass = $args->{'db_pass'} \|\| '';
bf4629e7	48	my $main_pkg_name = $translator->format_package_name('DBI');
bf4629e7	49	my $header = header_comment(__PACKAGE__, "# ");
bf4629e7	50	my $parser_type = ( split /::/, $translator->parser_type )[-1];
bf4629e7	51	my $from = $CDBI_auto_pkgs{ $parser_type } \|\| '';
d8b3bc7e	52	my $dsn = $args->{'dsn'} \|\| sprintf( 'dbi:%s:_',
	53	$CDBI_auto_pkgs{ $parser_type }
	54	? $CDBI_auto_pkgs{ $parser_type } : $parser_type
	55	);
	56	my $sep = '# ' . '-' x 67;
bf4629e7	57
6c45056f	58	#
	59	# Iterate over all tables
	60	#
bf4629e7	61	my ( %packages, $order );
6c45056f	62	for my $table ( $schema->get_tables ) {
6c45056f	63	my $table_name = $table->name or next;
6c45056f	64
bf4629e7	65	my $table_pkg_name = $translator->format_package_name($table_name);
	66	$packages{ $table_pkg_name } = {
	67	order => ++$order,
	68	pkg_name => $table_pkg_name,
	69	base => $main_pkg_name,
	70	table => $table_name,
	71	};
6c45056f	72
6c45056f	73	#
bf4629e7	74	# Primary key may have a differenct accessor method name
6c45056f	75	#
b75f2b12	76	if ( my $pk_xform = $translator->format_pk_name ) {
bf4629e7	77	if ( my $constraint = $table->primary_key ) {
bf4629e7	78	my $field = ($constraint->fields)[0];
b75f2b12	79	my $pk_name = $pk_xform->($table_pkg_name, $field);
bf4629e7	80
	81	$packages{ $table_pkg_name }{'pk_accessor'} =
	82	"#\n# Primary key accessor\n#\n".
	83	"sub $pk_name {\n shift->$field\n}\n"
	84	;
	85	}
6c45056f	86	}
bf4629e7	87
6c45056f	88	#
bf4629e7	89	# Use foreign keys to set up "has_a/has_many" relationships.
6c45056f	90	#
	91	foreach my $field ( $table->get_fields ) {
	92	if ( $field->is_foreign_key ) {
bf4629e7	93	my $table_name = $table->name;
6c45056f	94	my $field_name = $field->name;
	95	my $fk = $field->foreign_key_reference;
	96	my $ref_table = $fk->reference_table;
bf4629e7	97	my $ref_pkg = $translator->format_package_name($ref_table);
	98	my $ref_fld =
	99	$translator->format_fk_name($ref_table, $field_name);
6c45056f	100
bf4629e7	101	push @{ $packages{ $table_pkg_name }{'has_a'} },
	102	"$table_pkg_name->has_a(\n".
	103	" $field_name => '$ref_pkg'\n);\n\n".
	104	"sub $ref_fld {\n".
	105	" return shift->$field_name\n}\n\n"
	106	;
52fbac6a	107
bf4629e7	108	#
	109	# If this table "has a" to the other, then it follows
	110	# that the other table "has many" of this one, right?
	111	#
	112	push @{ $packages{ $ref_pkg }{'has_many'} },
d8b3bc7e	113	"$ref_pkg->has_many(\n '$table_name', ".
bf4629e7	114	"'$table_pkg_name' => '$field_name'\n);\n\n"
bf4629e7	115	;
6c45056f	116	}
6c45056f	117	}
df602cfb	118
bf4629e7	119	#
	120	# Identify link tables, defined as tables that have
	121	# only PK and FK fields.
	122	#
	123	# my %linkable;
	124	# my %linktable;
	125	# foreach my $table ( $schema->get_tables ) {
	126	# my $is_link = 1;
	127	# foreach my $field ( $table->get_fields ) {
	128	# unless ( $field->is_primary_key or $field->is_foreign_key ) {
	129	# $is_link = 0;
	130	# last;
	131	# }
	132	# }
	133	#
	134	# if ( $is_link ) {
	135	# foreach my $left ( $table->get_fields ) {
	136	# next unless $left->is_foreign_key and $schema->get_table(
	137	# $left->foreign_key_reference->reference_table
	138	# );
	139	#
	140	# next unless $left->is_foreign_key and $schema->get_table(
	141	# $left->foreign_key_reference->reference_table
	142	# )->get_field(
	143	# ($left->foreign_key_reference->reference_fields)[0]
	144	# )->is_primary_key;
	145	#
	146	# foreach my $right ( $table->get_fields ) {
	147	# #skip the diagonal
	148	# next if $left->name eq $right->name;
	149	#
	150	# next unless $right->is_foreign_key and
	151	# $schema->get_table(
	152	# $right->foreign_key_reference->reference_table
	153	# )
	154	# ;
	155	#
	156	# next unless $right->is_foreign_key and
	157	# $schema->get_table(
	158	# $right->foreign_key_reference->reference_table
	159	# )->get_field(
	160	# ($right->foreign_key_reference->reference_fields)[0]
	161	# )->is_primary_key
	162	# ;
	163	#
	164	#
	165	# $linkable{
	166	# $left->foreign_key_reference->reference_table
	167	# }{
	168	# $right->foreign_key_reference->reference_table
	169	# } = $table;
	170	#
	171	# $linkable{
	172	# $right->foreign_key_reference->reference_table
	173	# }{
	174	# $left->foreign_key_reference->reference_table
	175	# } = $table;
	176	#
	177	# $linktable{ $table->name } = $table;
	178	# }
	179	# }
	180	# }
	181	# }
	182	#
183	# #
184	# # Generate many-to-many linking methods for data tables
185	# #
186	# my $is_data = 0;
187	# for ( $table->get_fields ) {
188	# $is_data++ if !$_->is_foreign_key and !$_->is_primary_key;
189	# }
190	#
191	# my %linked;
192	# if ( $is_data ) {
193	# foreach my $link ( keys %{ $linkable{ $table->name } } ) {
194	# my $linkmethodname =
195	# "_".$translator->format_fk_name($table->name,$link)."_refs"
196	# ;
197	#
198	# $create .= $translator->format_package_name($table->name).
199	# "->has_many('$linkmethodname','".
200	# $translator->format_package_name(
201	# $linkable{$table->name}{$link}->name
202	# )."','".
203	# ($schema->get_table($link)->primary_key->fields)[0]."');\n"
204	# ;
205	#
206	# $create .= "sub ". $translator->format_fk_name($table,$link).
207	# # HARDCODED 's' HERE.
208	# # ADD CALLBACK FOR PLURALIZATION MANGLING
209	# "s {\n my \$self = shift; return map \$_->".$link.
210	# ", \$self->".$linkmethodname.";\n}\n\n"
211	# ;
212	# }
213	# }
214	}
6c45056f	215
bf4629e7	216	my $base_pkg = sprintf( 'Class::DBI%s', $from ? "::$from" : '' );
	217	my $create = join("\n",
	218	"package $main_pkg_name;\n",
	219	$header,
	220	"use strict;",
	221	"use base '$base_pkg';\n",
	222	"$main_pkg_name->set_db('Main', '$dsn', '$db_user', '$db_pass');\n\n",
	223	);
	224
	225	for my $pkg_name (
	226	sort { $packages{ $a }{'order'} <=> $packages{ $b }{'order'} }
	227	keys %packages
	228	) {
	229	my $pkg = $packages{ $pkg_name };
	230
	231	$create .= join("\n",
	232	$sep,
	233	"package ".$pkg->{'pkg_name'}.";",
	234	"use base '".$pkg->{'base'}."';",
	235	"use Class::DBI::Pager;\n\n",
	236	);
f42e7027	237
bf4629e7	238	if ( $from ) {
	239	$create .=
	240	$pkg->{'pkg_name'}."->set_up_table('".$pkg->{'table'}."');\n\n";
	241	}
	242	else {
	243	my $table = $schema->get_table( $pkg->{'table'} );
	244	my @field_names = map { $_->name } $table->get_fields;
	245
	246	$create .= join("\n",
	247	$pkg_name."->table('".$pkg->{'table'}."');\n",
	248	$pkg_name."->columns(All => qw/".
	249	join(' ', @field_names)."/);\n\n",
	250	);
	251	}
52fbac6a	252
bf4629e7	253	if ( my $pk = $pkg->{'pk_accessor'} ) {
	254	$create .= $pk;
	255	}
df602cfb	256
bf4629e7	257	if ( my @has_a = @{ $pkg->{'has_a'} \|\| [] } ) {
	258	$create .= $_ for @has_a;
	259	}
	260
	261	if ( my @has_many = @{ $pkg->{'has_many'} \|\| [] } ) {
	262	$create .= $_ for @has_many;
	263	}
6c45056f	264	}
df602cfb	265
bf4629e7	266	$create .= "1;\n";
	267
	268	return $create;
f42e7027	269	}
	270
	271	1;
	272
bf4629e7	273	# -------------------------------------------------------------------
	274
	275	=pod
f42e7027	276
	277	=head1 NAME
	278
bf4629e7	279	SQL::Translator::Producer::ClassDBI - create Class::DBI classes from schema
f42e7027	280
	281	=head1 SYNOPSIS
	282
1eee27d3	283	Use this producer as you would any other from SQL::Translator. See
1eee27d3	284	L<SQL::Translator> for details.
f42e7027	285
1eee27d3	286	This package utilizes SQL::Translator's formatting methods
	287	format_package_name(), format_pk_name(), format_fk_name(), and
	288	format_table_name() as it creates classes, one per table in the schema
	289	provided. An additional base class is also created for database connectivity
	290	configuration. See L<Class::DBI> for details on how this works.
f42e7027	291
6c45056f	292	=head1 AUTHORS
f42e7027	293
6c45056f	294	Allen Day E<lt>allenday@ucla.eduE<gt>
5f054727	295	Ying Zhang E<lt>zyolive@yahoo.comE<gt>,
6c45056f	296	Ken Y. Clark E<lt>kclark@cpan.org<gt>.