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

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

# -------------------------------------------------------------------
# $Id: ClassDBI.pm,v 1.22 2003-06-25 19:17:06 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.22 $ =~ /(\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 $parser_type   = $translator->parser_type;
    my $dsn           = $args->{'dsn'}     || "dbi:$CDBI_auto_pkgs{$parser_type}:_";
    my $main_pkg_name = $translator->format_package_name('DBI');
    my $header        = header_comment(__PACKAGE__, "# ");
    my $sep           = '# ' . '-' x 67;

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