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

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

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