[dbsrgits/DBIx-Class-Schema-Loader.git] / lib / DBIx / Class / Schema / Loader / Generic.pm

package DBIx::Class::Schema::Loader::Generic;

use strict;
use warnings;

use base qw/DBIx::Class::Schema/;

use Carp;
use Lingua::EN::Inflect;

require DBIx::Class::Core;

__PACKAGE__->mk_classdata('loader_data');

# XXX convert all usage of $class/$self->debug to ->debug_loader

=head1 NAME

DBIx::Class::Schema::Loader::Generic - Generic DBIx::Class::Schema::Loader Implementation.

=head1 SYNOPSIS

See L<DBIx::Class::Schema::Loader>

=head1 DESCRIPTION

=head2 OPTIONS

Available constructor options are:

=head3 additional_base_classes

List of additional base classes your table classes will use.

=head3 left_base_classes

List of additional base classes, that need to be leftmost.

=head3 additional_classes

List of additional classes which your table classes will use.

=head3 constraint

Only load tables matching regex.

=head3 exclude

Exclude tables matching regex.

=head3 debug

Enable debug messages.

=head3 dsn

DBI Data Source Name.

=head3 namespace

Namespace under which your table classes will be initialized.

=head3 password

Password.

=head3 relationships

Try to automatically detect/setup has_a and has_many relationships.

=head3 inflect

An hashref, which contains exceptions to Lingua::EN::Inflect::PL().
Useful for foreign language column names.

=head3 user

Username.

=head2 METHODS

=cut

=head3 new

Not intended to be called directly.  This is used internally by the
C<new()> method in L<DBIx::Class::Schema::Loader>.

=cut

sub _load_from_connection {
    my ( $class, %args ) = @_;
    if ( $args{debug} ) {
        no strict 'refs';
        *{"$class\::debug_loader"} = sub { 1 };
    }
    my $additional = $args{additional_classes} || [];
    $additional = [$additional] unless ref $additional eq 'ARRAY';
    my $additional_base = $args{additional_base_classes} || [];
    $additional_base = [$additional_base]
      unless ref $additional_base eq 'ARRAY';
    my $left_base = $args{left_base_classes} || [];
    $left_base = [$left_base] unless ref $left_base eq 'ARRAY';
    $class->loader_data({
        _datasource =>
          [ $args{dsn}, $args{user}, $args{password}, $args{options} ],
        _namespace       => $args{namespace} || $class,
        _additional      => $additional,
        _additional_base => $additional_base,
        _left_base       => $left_base,
        _constraint      => $args{constraint} || '.*',
        _exclude         => $args{exclude},
        _relationships   => $args{relationships},
        _inflect         => $args{inflect},
        _db_schema       => $args{db_schema},
        _drop_db_schema  => $args{drop_db_schema},
        TABLE_CLASSES    => {},
        MONIKERS         => {},
    });

    $class->connection(@{$class->loader_data->{_datasource}});
    warn qq/\### START DBIx::Class::Schema::Loader dump ###\n/ if $class->debug;
    $class->_load_classes;
    $class->_relationships                            if $class->loader_data->{_relationships};
    warn qq/\### END DBIx::Class::Schema::Loader dump ###\n/ if $class->debug;
    $class->storage->dbh->disconnect; # XXX this should be ->storage->disconnect later?

    1;
}

# The original table class name during Loader,
sub _find_table_class {
    my ( $class, $table ) = @_;
    return $class->loader_data->{TABLE_CLASSES}->{$table};
}

# Returns the moniker for a given table name,
# for use in $conn->resultset($moniker)
sub moniker {
    my ( $class, $table ) = @_;
    return $class->loader_data->{MONIKERS}->{$table};
}

=head3 debug

Overload to enable debug messages.

=cut

sub debug { 0 }

=head3 tables

Returns a sorted list of tables.

    my @tables = $loader->tables;

=cut

sub tables {
    my $class = shift;
    return sort keys %{ $class->loader_data->{MONIKERS} };
}

# Overload in your driver class
sub _db_classes { croak "ABSTRACT METHOD" }

# Setup has_a and has_many relationships
sub _belongs_to_many {
    my ( $class, $table, $column, $other, $other_column ) = @_;
    my $table_class = $class->_find_table_class($table);
    my $other_class = $class->_find_table_class($other);

    warn qq/\# Belongs_to relationship\n/ if $class->debug;

    if($other_column) {
        warn qq/$table_class->belongs_to( '$column' => '$other_class',/
          .  qq/ { "foreign.$other_column" => "self.$column" },/
          .  qq/ { accessor => 'filter' });\n\n/
          if $class->debug;
        $table_class->belongs_to( $column => $other_class, 
          { "foreign.$other_column" => "self.$column" },
          { accessor => 'filter' }
        );
    }
    else {
        warn qq/$table_class->belongs_to( '$column' => '$other_class' );\n\n/
          if $class->debug;
        $table_class->belongs_to( $column => $other_class );
    }

    my ($table_class_base) = $table_class =~ /.*::(.+)/;
    my $plural = Lingua::EN::Inflect::PL( lc $table_class_base );
    $plural = $class->loader_data->{_inflect}->{ lc $table_class_base }
      if $class->loader_data->{_inflect}
      and exists $class->loader_data->{_inflect}->{ lc $table_class_base };

    warn qq/\# Has_many relationship\n/ if $class->debug;

    if($other_column) {
        warn qq/$other_class->has_many( '$plural' => '$table_class',/
          .  qq/ { "foreign.$column" => "self.$other_column" } );\n\n/
          if $class->debug;
        $other_class->has_many( $plural => $table_class,
                                { "foreign.$column" => "self.$other_column" }
                              );
    }
    else {
        warn qq/$other_class->has_many( '$plural' => '$table_class',/
          .  qq/'$other_column' );\n\n/
          if $class->debug;
        $other_class->has_many( $plural => $table_class, $column );
    }
}

# Load and setup classes
sub _load_classes {
    my $class = shift;

    my $namespace    = $class->loader_data->{_namespace};

    my @tables          = $class->_tables();
    my @db_classes      = $class->_db_classes();
    my $additional      = join '', map "use $_;\n", @{ $class->loader_data->{_additional} };
    my $additional_base = join '', map "use base '$_';\n",
      @{ $class->loader_data->{_additional_base} };
    my $left_base  = join '', map "use base '$_';\n", @{ $class->loader_data->{_left_base} };
    my $constraint = $class->loader_data->{_constraint};
    my $exclude    = $class->loader_data->{_exclude};

    foreach my $table (@tables) {
        next unless $table =~ /$constraint/;
        next if ( defined $exclude && $table =~ /$exclude/ );

        my $table = lc $table;
        my $table_name_db_schema = $table;
        my $table_name_only = $table_name_db_schema;
        my ($db_schema, $tbl) = split /\./, $table;
        if($tbl) {
            $table_name_db_schema = $tbl if $class->loader_data->{_drop_db_schema};
            $table_name_only = $tbl;
        }
        else {
            undef $db_schema;
        }

        my $table_subclass = $class->_table2subclass($db_schema, $table_name_only);
        my $table_class = $namespace . '::' . $table_subclass;

        $class->inject_base( $table_class, 'DBIx::Class::Core' );
        $_->require for @db_classes;
        $class->inject_base( $table_class, $_ ) for @db_classes;
        warn qq/\# Initializing table "$table_name_db_schema" as "$table_class"\n/ if $class->debug;
        $table_class->table(lc $table_name_db_schema);

        my ( $cols, $pks ) = $class->_table_info($table_name_db_schema);
        carp("$table has no primary key") unless @$pks;
        $table_class->add_columns(@$cols);
        $table_class->set_primary_key(@$pks) if @$pks;

        my $code = "package $table_class;\n$additional_base$additional$left_base";
        warn qq/$code/                        if $class->debug;
        warn qq/$table_class->table('$table_name_db_schema');\n/ if $class->debug;
        my $columns = join "', '", @$cols;
        warn qq/$table_class->add_columns('$columns')\n/ if $class->debug;
        my $primaries = join "', '", @$pks;
        warn qq/$table_class->set_primary_key('$primaries')\n/ if $class->debug && @$pks;
        eval $code;
        croak qq/Couldn't load additional classes "$@"/ if $@;
        unshift @{"$table_class\::ISA"}, $_ foreach ( @{ $class->loader_data->{_left_base} } );

        $class->register_class($table_subclass, $table_class);
        $class->loader_data->{TABLE_CLASSES}->{$table_name_db_schema} = $table_class;
        $class->loader_data->{MONIKERS}->{$table_name_db_schema} = $table_subclass;
    }
}

# Find and setup relationships
sub _relationships {
    my $class = shift;
    my $dbh = $class->storage->dbh;
    foreach my $table ( $class->tables ) {
        my $quoter = $dbh->get_info(29) || q{"};
        if ( my $sth = $dbh->foreign_key_info( '', '', '', '', '', $table ) ) {
            for my $res ( @{ $sth->fetchall_arrayref( {} ) } ) {
                my $column = $res->{FK_COLUMN_NAME};
                my $other  = $res->{UK_TABLE_NAME};
                my $other_column  = $res->{UK_COLUMN_NAME};
                $column =~ s/$quoter//g;
                $other =~ s/$quoter//g;
                $other_column =~ s/$quoter//g;
                eval { $class->_belongs_to_many( $table, $column, $other,
                  $other_column ) };
                warn qq/\# belongs_to_many failed "$@"\n\n/
                  if $@ && $class->debug;
            }
        }
    }
}

# Make a subclass (dbix moniker) from a table
sub _table2subclass {
    my ( $class, $db_schema, $table ) = @_;

    my $table_subclass = join '', map ucfirst, split /[\W_]+/, $table;

    if($db_schema && !$class->loader_data->{_drop_db_schema}) {
        $table_subclass = (ucfirst lc $db_schema) . '-' . $table_subclass;
    }

    $table_subclass;
}

# Overload in driver class
sub _tables { croak "ABSTRACT METHOD" }

sub _table_info { croak "ABSTRACT METHOD" }

=head1 SEE ALSO

L<DBIx::Class::Schema::Loader>

=cut

1;
Commit	Line	Data
18fca96a	1	package DBIx::Class::Schema::Loader::Generic;
a78e3fed	2
a78e3fed	3	use strict;
a4a19f3c	4	use warnings;
	5
	6	use base qw/DBIx::Class::Schema/;
	7
a78e3fed	8	use Carp;
a78e3fed	9	use Lingua::EN::Inflect;
a4a19f3c	10
a78e3fed	11	require DBIx::Class::Core;
a4a19f3c	12
	13	__PACKAGE__->mk_classdata('loader_data');
	14
	15	# XXX convert all usage of $class/$self->debug to ->debug_loader
a78e3fed	16
	17	=head1 NAME
	18
18fca96a	19	DBIx::Class::Schema::Loader::Generic - Generic DBIx::Class::Schema::Loader Implementation.
a78e3fed	20
	21	=head1 SYNOPSIS
	22
18fca96a	23	See L<DBIx::Class::Schema::Loader>
a78e3fed	24
	25	=head1 DESCRIPTION
	26
	27	=head2 OPTIONS
	28
	29	Available constructor options are:
	30
	31	=head3 additional_base_classes
	32
	33	List of additional base classes your table classes will use.
	34
	35	=head3 left_base_classes
	36
	37	List of additional base classes, that need to be leftmost.
	38
	39	=head3 additional_classes
	40
	41	List of additional classes which your table classes will use.
	42
	43	=head3 constraint
	44
	45	Only load tables matching regex.
	46
	47	=head3 exclude
	48
	49	Exclude tables matching regex.
	50
	51	=head3 debug
	52
	53	Enable debug messages.
	54
	55	=head3 dsn
	56
	57	DBI Data Source Name.
	58
	59	=head3 namespace
	60
	61	Namespace under which your table classes will be initialized.
	62
	63	=head3 password
	64
	65	Password.
	66
	67	=head3 relationships
	68
	69	Try to automatically detect/setup has_a and has_many relationships.
	70
	71	=head3 inflect
	72
	73	An hashref, which contains exceptions to Lingua::EN::Inflect::PL().
	74	Useful for foreign language column names.
	75
	76	=head3 user
	77
	78	Username.
	79
	80	=head2 METHODS
	81
	82	=cut
	83
	84	=head3 new
	85
	86	Not intended to be called directly. This is used internally by the
18fca96a	87	C<new()> method in L<DBIx::Class::Schema::Loader>.
a78e3fed	88
	89	=cut
	90
a4a19f3c	91	sub _load_from_connection {
a78e3fed	92	my ( $class, %args ) = @_;
	93	if ( $args{debug} ) {
	94	no strict 'refs';
a4a19f3c	95	*{"$class\::debug_loader"} = sub { 1 };
a78e3fed	96	}
	97	my $additional = $args{additional_classes} \|\| [];
	98	$additional = [$additional] unless ref $additional eq 'ARRAY';
	99	my $additional_base = $args{additional_base_classes} \|\| [];
	100	$additional_base = [$additional_base]
	101	unless ref $additional_base eq 'ARRAY';
	102	my $left_base = $args{left_base_classes} \|\| [];
	103	$left_base = [$left_base] unless ref $left_base eq 'ARRAY';
a4a19f3c	104	$class->loader_data({
a78e3fed	105	_datasource =>
a78e3fed	106	[ $args{dsn}, $args{user}, $args{password}, $args{options} ],
a4a19f3c	107	_namespace => $args{namespace} \|\| $class,
a78e3fed	108	_additional => $additional,
	109	_additional_base => $additional_base,
	110	_left_base => $left_base,
	111	_constraint => $args{constraint} \|\| '.*',
	112	_exclude => $args{exclude},
	113	_relationships => $args{relationships},
	114	_inflect => $args{inflect},
a4a19f3c	115	_db_schema => $args{db_schema},
a4a19f3c	116	_drop_db_schema => $args{drop_db_schema},
af6c2665	117	TABLE_CLASSES => {},
af6c2665	118	MONIKERS => {},
a4a19f3c	119	});
	120
	121	$class->connection(@{$class->loader_data->{_datasource}});
	122	warn qq/\### START DBIx::Class::Schema::Loader dump ###\n/ if $class->debug;
	123	$class->_load_classes;
	124	$class->_relationships if $class->loader_data->{_relationships};
	125	warn qq/\### END DBIx::Class::Schema::Loader dump ###\n/ if $class->debug;
	126	$class->storage->dbh->disconnect; # XXX this should be ->storage->disconnect later?
	127
	128	1;
a78e3fed	129	}
a78e3fed	130
af6c2665	131	# The original table class name during Loader,
af6c2665	132	sub _find_table_class {
a4a19f3c	133	my ( $class, $table ) = @_;
a4a19f3c	134	return $class->loader_data->{TABLE_CLASSES}->{$table};
a78e3fed	135	}
a78e3fed	136
af6c2665	137	# Returns the moniker for a given table name,
	138	# for use in $conn->resultset($moniker)
	139	sub moniker {
a4a19f3c	140	my ( $class, $table ) = @_;
a4a19f3c	141	return $class->loader_data->{MONIKERS}->{$table};
a78e3fed	142	}
	143
	144	=head3 debug
	145
	146	Overload to enable debug messages.
	147
	148	=cut
	149
	150	sub debug { 0 }
	151
	152	=head3 tables
	153
	154	Returns a sorted list of tables.
	155
	156	my @tables = $loader->tables;
	157
	158	=cut
	159
	160	sub tables {
a4a19f3c	161	my $class = shift;
a4a19f3c	162	return sort keys %{ $class->loader_data->{MONIKERS} };
a78e3fed	163	}
	164
	165	# Overload in your driver class
	166	sub _db_classes { croak "ABSTRACT METHOD" }
	167
	168	# Setup has_a and has_many relationships
	169	sub _belongs_to_many {
a4a19f3c	170	my ( $class, $table, $column, $other, $other_column ) = @_;
	171	my $table_class = $class->_find_table_class($table);
	172	my $other_class = $class->_find_table_class($other);
a78e3fed	173
a4a19f3c	174	warn qq/\# Belongs_to relationship\n/ if $class->debug;
a78e3fed	175
	176	if($other_column) {
	177	warn qq/$table_class->belongs_to( '$column' => '$other_class',/
	178	. qq/ { "foreign.$other_column" => "self.$column" },/
	179	. qq/ { accessor => 'filter' });\n\n/
a4a19f3c	180	if $class->debug;
a78e3fed	181	$table_class->belongs_to( $column => $other_class,
	182	{ "foreign.$other_column" => "self.$column" },
	183	{ accessor => 'filter' }
	184	);
	185	}
	186	else {
	187	warn qq/$table_class->belongs_to( '$column' => '$other_class' );\n\n/
a4a19f3c	188	if $class->debug;
a78e3fed	189	$table_class->belongs_to( $column => $other_class );
	190	}
	191
	192	my ($table_class_base) = $table_class =~ /.*::(.+)/;
	193	my $plural = Lingua::EN::Inflect::PL( lc $table_class_base );
a4a19f3c	194	$plural = $class->loader_data->{_inflect}->{ lc $table_class_base }
	195	if $class->loader_data->{_inflect}
	196	and exists $class->loader_data->{_inflect}->{ lc $table_class_base };
a78e3fed	197
a4a19f3c	198	warn qq/\# Has_many relationship\n/ if $class->debug;
a78e3fed	199
	200	if($other_column) {
	201	warn qq/$other_class->has_many( '$plural' => '$table_class',/
	202	. qq/ { "foreign.$column" => "self.$other_column" } );\n\n/
a4a19f3c	203	if $class->debug;
a78e3fed	204	$other_class->has_many( $plural => $table_class,
	205	{ "foreign.$column" => "self.$other_column" }
	206	);
	207	}
	208	else {
	209	warn qq/$other_class->has_many( '$plural' => '$table_class',/
	210	. qq/'$other_column' );\n\n/
a4a19f3c	211	if $class->debug;
a78e3fed	212	$other_class->has_many( $plural => $table_class, $column );
	213	}
	214	}
	215
	216	# Load and setup classes
	217	sub _load_classes {
a4a19f3c	218	my $class = shift;
af6c2665	219
a4a19f3c	220	my $namespace = $class->loader_data->{_namespace};
af6c2665	221
a4a19f3c	222	my @tables = $class->_tables();
	223	my @db_classes = $class->_db_classes();
	224	my $additional = join '', map "use $_;\n", @{ $class->loader_data->{_additional} };
a78e3fed	225	my $additional_base = join '', map "use base '$_';\n",
a4a19f3c	226	@{ $class->loader_data->{_additional_base} };
	227	my $left_base = join '', map "use base '$_';\n", @{ $class->loader_data->{_left_base} };
	228	my $constraint = $class->loader_data->{_constraint};
	229	my $exclude = $class->loader_data->{_exclude};
a78e3fed	230
a78e3fed	231	foreach my $table (@tables) {
	232	next unless $table =~ /$constraint/;
	233	next if ( defined $exclude && $table =~ /$exclude/ );
af6c2665	234
	235	my $table = lc $table;
	236	my $table_name_db_schema = $table;
	237	my $table_name_only = $table_name_db_schema;
	238	my ($db_schema, $tbl) = split /\./, $table;
a78e3fed	239	if($tbl) {
a4a19f3c	240	$table_name_db_schema = $tbl if $class->loader_data->{_drop_db_schema};
af6c2665	241	$table_name_only = $tbl;
a78e3fed	242	}
af6c2665	243	else {
	244	undef $db_schema;
	245	}
	246
a4a19f3c	247	my $table_subclass = $class->_table2subclass($db_schema, $table_name_only);
a4a19f3c	248	my $table_class = $namespace . '::' . $table_subclass;
af6c2665	249
a4a19f3c	250	$class->inject_base( $table_class, 'DBIx::Class::Core' );
a78e3fed	251	$_->require for @db_classes;
a4a19f3c	252	$class->inject_base( $table_class, $_ ) for @db_classes;
	253	warn qq/\# Initializing table "$table_name_db_schema" as "$table_class"\n/ if $class->debug;
	254	$table_class->table(lc $table_name_db_schema);
af6c2665	255
a4a19f3c	256	my ( $cols, $pks ) = $class->_table_info($table_name_db_schema);
a78e3fed	257	carp("$table has no primary key") unless @$pks;
a4a19f3c	258	$table_class->add_columns(@$cols);
a4a19f3c	259	$table_class->set_primary_key(@$pks) if @$pks;
af6c2665	260
a4a19f3c	261	my $code = "package $table_class;\n$additional_base$additional$left_base";
	262	warn qq/$code/ if $class->debug;
	263	warn qq/$table_class->table('$table_name_db_schema');\n/ if $class->debug;
a78e3fed	264	my $columns = join "', '", @$cols;
a4a19f3c	265	warn qq/$table_class->add_columns('$columns')\n/ if $class->debug;
a78e3fed	266	my $primaries = join "', '", @$pks;
a4a19f3c	267	warn qq/$table_class->set_primary_key('$primaries')\n/ if $class->debug && @$pks;
a78e3fed	268	eval $code;
a78e3fed	269	croak qq/Couldn't load additional classes "$@"/ if $@;
a4a19f3c	270	unshift @{"$table_class\::ISA"}, $_ foreach ( @{ $class->loader_data->{_left_base} } );
af6c2665	271
a4a19f3c	272	$class->register_class($table_subclass, $table_class);
	273	$class->loader_data->{TABLE_CLASSES}->{$table_name_db_schema} = $table_class;
	274	$class->loader_data->{MONIKERS}->{$table_name_db_schema} = $table_subclass;
a78e3fed	275	}
	276	}
	277
	278	# Find and setup relationships
	279	sub _relationships {
a4a19f3c	280	my $class = shift;
	281	my $dbh = $class->storage->dbh;
	282	foreach my $table ( $class->tables ) {
a78e3fed	283	my $quoter = $dbh->get_info(29) \|\| q{"};
	284	if ( my $sth = $dbh->foreign_key_info( '', '', '', '', '', $table ) ) {
	285	for my $res ( @{ $sth->fetchall_arrayref( {} ) } ) {
	286	my $column = $res->{FK_COLUMN_NAME};
	287	my $other = $res->{UK_TABLE_NAME};
	288	my $other_column = $res->{UK_COLUMN_NAME};
	289	$column =~ s/$quoter//g;
	290	$other =~ s/$quoter//g;
	291	$other_column =~ s/$quoter//g;
a4a19f3c	292	eval { $class->_belongs_to_many( $table, $column, $other,
a78e3fed	293	$other_column ) };
a78e3fed	294	warn qq/\# belongs_to_many failed "$@"\n\n/
a4a19f3c	295	if $@ && $class->debug;
a78e3fed	296	}
	297	}
	298	}
	299	}
	300
af6c2665	301	# Make a subclass (dbix moniker) from a table
af6c2665	302	sub _table2subclass {
a4a19f3c	303	my ( $class, $db_schema, $table ) = @_;
af6c2665	304
a4a19f3c	305	my $table_subclass = join '', map ucfirst, split /[\W_]+/, $table;
af6c2665	306
a4a19f3c	307	if($db_schema && !$class->loader_data->{_drop_db_schema}) {
a4a19f3c	308	$table_subclass = (ucfirst lc $db_schema) . '-' . $table_subclass;
a78e3fed	309	}
af6c2665	310
a4a19f3c	311	$table_subclass;
a78e3fed	312	}
	313
	314	# Overload in driver class
	315	sub _tables { croak "ABSTRACT METHOD" }
	316
	317	sub _table_info { croak "ABSTRACT METHOD" }
	318
	319	=head1 SEE ALSO
	320
18fca96a	321	L<DBIx::Class::Schema::Loader>
a78e3fed	322
	323	=cut
	324
	325	1;