1 package DBIx::Class::Schema::Loader::RelBuilder;
5 use base 'Class::Accessor::Grouped';
7 use Carp::Clan qw/^DBIx::Class/;
8 use Scalar::Util 'weaken';
9 use Lingua::EN::Inflect::Phrase ();
10 use Lingua::EN::Tagger ();
11 use DBIx::Class::Schema::Loader::Utils qw/split_name slurp_file/;
14 use Class::Inspector ();
15 use List::MoreUtils 'apply';
18 our $VERSION = '0.07010';
22 # remote_relname -- name of relationship from the local table referring to the remote table
23 # local_relname -- name of relationship from the remote table referring to the local table
24 # remote_method -- relationship type from remote table to local table, usually has_many
28 DBIx::Class::Schema::Loader::RelBuilder - Builds relationships for DBIx::Class::Schema::Loader
32 See L<DBIx::Class::Schema::Loader> and L<DBIx::Class::Schema::Loader::Base>.
36 This class builds relationships for L<DBIx::Class::Schema::Loader>. This
37 is module is not (yet) for external use.
43 Arguments: $loader object
50 local_moniker (scalar) => [ fk_info (arrayref), uniq_info (arrayref) ]
54 This generates the code for the relationships of each table.
56 C<local_moniker> is the moniker name of the table which had the REFERENCES
57 statements. The fk_info arrayref's contents should take the form:
61 local_columns => [ 'col2', 'col3' ],
62 remote_columns => [ 'col5', 'col7' ],
63 remote_moniker => 'AnotherTableMoniker',
66 local_columns => [ 'col1', 'col4' ],
67 remote_columns => [ 'col1', 'col2' ],
68 remote_moniker => 'YetAnotherTableMoniker',
73 The uniq_info arrayref's contents should take the form:
77 uniq_constraint_name => [ 'col1', 'col2' ],
80 another_uniq_constraint_name => [ 'col1', 'col2' ],
84 This method will return the generated relationships as a hashref keyed on the
85 class names. The values are arrayrefs of hashes containing method name and
89 'Some::Source::Class' => [
90 { method => 'belongs_to', arguments => [ 'col1', 'Another::Source::Class' ],
91 { method => 'has_many', arguments => [ 'anothers', 'Yet::Another::Source::Class', 'col15' ],
93 'Another::Source::Class' => [
101 __PACKAGE__->mk_group_accessors('simple', qw/
114 my ($class, $loader) = @_;
116 # from old POD about this constructor:
117 # C<$schema_class> should be a schema class name, where the source
118 # classes have already been set up and registered. Column info,
119 # primary key, and unique constraints will be drawn from this
120 # schema for all of the existing source monikers.
122 # Options inflect_plural and inflect_singular are optional, and
123 # are better documented in L<DBIx::Class::Schema::Loader::Base>.
127 schema => $loader->schema,
128 inflect_plural => $loader->inflect_plural,
129 inflect_singular => $loader->inflect_singular,
130 relationship_attrs => $loader->relationship_attrs,
131 rel_collision_map => $loader->rel_collision_map,
132 rel_name_map => $loader->rel_name_map,
136 weaken $self->{loader}; #< don't leak
138 bless $self => $class;
140 # validate the relationship_attrs arg
141 if( defined $self->relationship_attrs ) {
142 ref $self->relationship_attrs eq 'HASH'
143 or croak "relationship_attrs must be a hashref";
150 # pluralize a relationship name
151 sub _inflect_plural {
152 my ($self, $relname) = @_;
154 return '' if !defined $relname || $relname eq '';
159 if( ref $self->inflect_plural eq 'HASH' ) {
160 if (exists $self->inflect_plural->{$relname}) {
161 $result = $self->inflect_plural->{$relname};
165 elsif( ref $self->inflect_plural eq 'CODE' ) {
166 my $inflected = $self->inflect_plural->($relname);
168 $result = $inflected;
173 return ($result, $mapped) if $mapped;
175 return ($self->_to_PL($relname), 0);
178 # Singularize a relationship name
179 sub _inflect_singular {
180 my ($self, $relname) = @_;
182 return '' if !defined $relname || $relname eq '';
187 if( ref $self->inflect_singular eq 'HASH' ) {
188 if (exists $self->inflect_singular->{$relname}) {
189 $result = $self->inflect_singular->{$relname};
193 elsif( ref $self->inflect_singular eq 'CODE' ) {
194 my $inflected = $self->inflect_singular->($relname);
196 $result = $inflected;
201 return ($result, $mapped) if $mapped;
203 return ($self->_to_S($relname), 0);
207 my ($self, $name) = @_;
210 my $plural = Lingua::EN::Inflect::Phrase::to_PL($name);
217 my ($self, $name) = @_;
220 my $singular = Lingua::EN::Inflect::Phrase::to_S($name);
221 $singular =~ s/ /_/g;
226 sub _default_relationship_attrs { +{
236 on_delete => 'CASCADE',
237 on_update => 'CASCADE',
242 # accessor for options to be passed to each generated relationship
243 # type. take single argument, the relationship type name, and returns
244 # either a hashref (if some options are set), or nothing
245 sub _relationship_attrs {
246 my ( $self, $reltype ) = @_;
247 my $r = $self->relationship_attrs;
250 %{ $self->_default_relationship_attrs->{$reltype} || {} },
254 if( my $specific = $r->{$reltype} ) {
255 while( my ($k,$v) = each %$specific ) {
263 my ($self, $a, $b) = @_;
265 return unless @$a == @$b;
267 for (my $i = 0; $i < @$a; $i++) {
268 return unless $a->[$i] eq $b->[$i];
274 my ($self, $local_moniker, $local_cols) = @_;
276 # get our base set of attrs from _relationship_attrs, if present
277 my $attrs = $self->_relationship_attrs('belongs_to') || {};
279 # If the referring column is nullable, make 'belongs_to' an
280 # outer join, unless explicitly set by relationship_attrs
281 my $nullable = grep { $self->schema->source($local_moniker)->column_info($_)->{is_nullable} } @$local_cols;
282 $attrs->{join_type} = 'LEFT' if $nullable && !defined $attrs->{join_type};
288 my ($self, $name) = @_;
291 # scalar ref for weird table name (like one containing a '.')
292 ($name = $$name) =~ s/\W+/_/g;
295 # remove 'schema.' prefix if any
296 $name =~ s/^[^.]+\.//;
302 sub _normalize_name {
303 my ($self, $name) = @_;
305 $name = $self->_sanitize_name($name);
307 my @words = split_name $name;
309 return join '_', map lc, @words;
312 sub _remote_relname {
313 my ($self, $remote_table, $cond) = @_;
316 # for single-column case, set the remote relname to the column
317 # name, to make filter accessors work, but strip trailing _id
318 if(scalar keys %{$cond} == 1) {
319 my ($col) = values %{$cond};
320 $col = $self->_normalize_name($col);
322 ($remote_relname) = $self->_inflect_singular($col);
325 ($remote_relname) = $self->_inflect_singular($self->_normalize_name($remote_table));
328 return $remote_relname;
331 sub _resolve_relname_collision {
332 my ($self, $moniker, $cols, $relname) = @_;
334 return $relname if $relname eq 'id'; # this shouldn't happen, but just in case
336 my $table = $self->loader->tables->{$moniker};
338 if ($self->loader->_is_result_class_method($relname, $table)) {
339 if (my $map = $self->rel_collision_map) {
340 for my $re (keys %$map) {
341 if (my @matches = $relname =~ /$re/) {
342 return sprintf $map->{$re}, @matches;
347 my $new_relname = $relname;
348 while ($self->loader->_is_result_class_method($new_relname, $table)) {
349 $new_relname .= '_rel'
353 Relationship '$relname' in source '$moniker' for columns '@{[ join ',', @$cols ]}' collides with an inherited method.
354 Renaming to '$new_relname'.
355 See "RELATIONSHIP NAME COLLISIONS" in perldoc DBIx::Class::Schema::Loader::Base .
365 my ($self, $tables) = @_;
367 # make a copy to destroy
368 my @tables = @$tables;
372 while (my ($local_moniker, $rels, $uniqs) = @{ shift @tables || [] }) {
373 my $local_class = $self->schema->class($local_moniker);
376 foreach my $rel (@$rels) {
377 next if !$rel->{remote_source};
378 $counters{$rel->{remote_source}}++;
381 foreach my $rel (@$rels) {
382 my $remote_moniker = $rel->{remote_source}
385 my $remote_class = $self->schema->class($remote_moniker);
386 my $remote_obj = $self->schema->source($remote_moniker);
387 my $remote_cols = $rel->{remote_columns} || [ $remote_obj->primary_columns ];
389 my $local_cols = $rel->{local_columns};
391 if($#$local_cols != $#$remote_cols) {
392 croak "Column count mismatch: $local_moniker (@$local_cols) "
393 . "$remote_moniker (@$remote_cols)";
397 foreach my $i (0 .. $#$local_cols) {
398 $cond{$remote_cols->[$i]} = $local_cols->[$i];
401 my ( $local_relname, $remote_relname, $remote_method ) =
402 $self->_relnames_and_method( $local_moniker, $rel, \%cond, $uniqs, \%counters );
403 my $local_method = 'belongs_to';
405 ($remote_relname) = $self->_rel_name_map($remote_relname, $local_method, $local_class, $local_moniker, $local_cols, $remote_class, $remote_moniker, $remote_cols);
406 ($local_relname) = $self->_rel_name_map($local_relname, $remote_method, $remote_class, $remote_moniker, $remote_cols, $local_class, $local_moniker, $local_cols);
408 $remote_relname = $self->_resolve_relname_collision($local_moniker, $local_cols, $remote_relname);
409 $local_relname = $self->_resolve_relname_collision($remote_moniker, $remote_cols, $local_relname);
411 push(@{$all_code->{$local_class}},
412 { method => $local_method,
413 args => [ $remote_relname,
416 $self->_remote_attrs($local_moniker, $local_cols),
419 local_class => $local_class,
420 local_moniker => $local_moniker,
421 remote_moniker => $remote_moniker,
426 my %rev_cond = reverse %cond;
427 for (keys %rev_cond) {
428 $rev_cond{"foreign.$_"} = "self.".$rev_cond{$_};
429 delete $rev_cond{$_};
432 push(@{$all_code->{$remote_class}},
433 { method => $remote_method,
434 args => [ $local_relname,
437 $self->_relationship_attrs($remote_method),
440 local_class => $remote_class,
441 local_moniker => $remote_moniker,
442 remote_moniker => $local_moniker,
449 # disambiguate rels with the same name
450 foreach my $class (keys %$all_code) {
451 my $dups = $self->_duplicates($all_code->{$class});
453 $self->_disambiguate($all_code->{$class}, $dups) if $dups;
462 my ($self, $rels) = @_;
464 my @rels = map [ $_->{args}[0] => $_ ], @$rels;
466 $rel_names{$_}++ foreach map $_->[0], @rels;
468 my @dups = grep $rel_names{$_} > 1, keys %rel_names;
472 foreach my $dup (@dups) {
473 $dups{$dup} = [ map $_->[1], grep { $_->[0] eq $dup } @rels ];
484 $self->__tagger(Lingua::EN::Tagger->new) unless $self->__tagger;
486 return $self->__tagger;
490 my ($self, @cols) = @_;
494 foreach my $col (@cols) {
495 my @words = split_name $col;
497 my $tagged = $self->_tagger->get_readable(join ' ', @words);
499 push @adjectives, $tagged =~ m{\G(\w+)/JJ\s+}g;
506 my ($self, $all_rels, $dups) = @_;
508 foreach my $dup (keys %$dups) {
509 my @rels = @{ $dups->{$dup} };
511 foreach my $rel (@rels) {
512 next if $rel->{method} eq 'belongs_to';
514 my @to_cols = apply { s/^foreign\.//i }
515 keys %{ $rel->{args}[2] };
517 my @adjectives = $self->_adjectives(@to_cols);
519 # If there are no adjectives, and there is only one might_have
520 # rel to that class, we hardcode 'active'.
522 my $to_class = $rel->{args}[1];
524 if ((not @adjectives)
525 && (grep { $_->{method} eq 'might_have'
526 && $_->{args}[1] eq $to_class } @$all_rels) == 1) {
528 @adjectives = 'active';
532 my $rel_name = join '_', sort(@adjectives), $rel->{args}[0];
534 ($rel_name) = $rel->{method} eq 'might_have' ?
535 $self->_inflect_singular($rel_name)
537 $self->_inflect_plural($rel_name);
539 my ($local_class, $local_moniker, $remote_moniker)
541 {qw/local_class local_moniker remote_moniker/};
543 my @from_cols = apply { s/^self\.//i }
544 values %{ $rel->{args}[2] };
546 ($rel_name) = $self->_rel_name_map($rel_name, $rel->{method}, $local_class, $local_moniker, \@from_cols, $to_class, $remote_moniker, \@to_cols);
548 $rel_name = $self->_resolve_relname_collision($local_moniker, \@from_cols, $rel_name);
550 $rel->{args}[0] = $rel_name;
555 # Check again for duplicates, since the heuristics above may not have resolved them all.
557 if ($dups = $self->_duplicates($all_rels)) {
558 foreach my $dup (keys %$dups) {
560 my @rels = map $_->[1], sort { $a->[0] <=> $b->[0] } map [
561 ($_->{method} eq 'belongs_to' ? 3 : $_->{method} eq 'has_many' ? 2 : 1), $_
562 ], @{ $dups->{$dup} };
566 foreach my $rel (@rels[1 .. $#rels]) {
567 my $inflect_type = $rel->{method} eq 'has_many' ?
572 my $inflect_method = "_$inflect_type";
574 my $relname_new_uninflected = $rel->{args}[0] . "_$rel_num";
578 my ($local_class, $local_moniker, $remote_moniker)
580 {qw/local_class local_moniker remote_moniker/};
582 my @from_cols = apply { s/^self\.//i }
583 values %{ $rel->{args}[2] };
585 my @to_cols = apply { s/^foreign\.//i }
586 keys %{ $rel->{args}[2] };
588 my $to_class = $rel->{args}[1];
590 my ($relname_new, $inflect_mapped) =
591 $self->$inflect_method($relname_new_uninflected);
595 ($relname_new, $rel_name_mapped) = $self->_rel_name_map($relname_new, $rel->{method}, $local_class, $local_moniker, \@from_cols, $to_class, $remote_moniker, \@to_cols);
597 my $mapped = $inflect_mapped || $rel_name_mapped;
599 warn <<"EOF" unless $mapped;
600 Could not find a proper name for relationship '$relname_new' in source
601 '$local_moniker' for columns '@{[ join ',', @from_cols ]}'. Supply a value in
602 '$inflect_type' or 'rel_name_map' for '$relname_new_uninflected' to name this
606 $relname_new = $self->_resolve_relname_collision($local_moniker, \@from_cols, $relname_new);
608 $rel->{args}[0] = $relname_new;
614 sub _relnames_and_method {
615 my ( $self, $local_moniker, $rel, $cond, $uniqs, $counters ) = @_;
617 my $remote_moniker = $rel->{remote_source};
618 my $remote_obj = $self->schema->source( $remote_moniker );
619 my $remote_class = $self->schema->class( $remote_moniker );
620 my $remote_relname = $self->_remote_relname( $remote_obj->from, $cond);
622 my $local_cols = $rel->{local_columns};
623 my $local_table = $self->schema->source($local_moniker)->from;
624 my $local_class = $self->schema->class($local_moniker);
625 my $local_source = $self->schema->source($local_moniker);
627 my $local_relname_uninflected = $self->_normalize_name($local_table);
628 my ($local_relname) = $self->_inflect_plural($self->_normalize_name($local_table));
630 my $remote_method = 'has_many';
632 # If the local columns have a UNIQUE constraint, this is a one-to-one rel
633 if ($self->_array_eq([ $local_source->primary_columns ], $local_cols) ||
634 grep { $self->_array_eq($_->[1], $local_cols) } @$uniqs) {
635 $remote_method = 'might_have';
636 ($local_relname) = $self->_inflect_singular($local_relname_uninflected);
639 # If more than one rel between this pair of tables, use the local
640 # col names to distinguish, unless the rel was created previously.
641 if ($counters->{$remote_moniker} > 1) {
642 my $relationship_exists = 0;
644 if (-f (my $existing_remote_file = $self->loader->get_dump_filename($remote_class))) {
645 my $class = "${remote_class}Temporary";
647 if (not Class::Inspector->loaded($class)) {
648 my $code = slurp_file $existing_remote_file;
650 $code =~ s/(?<=package $remote_class)/Temporary/g;
652 $code =~ s/__PACKAGE__->meta->make_immutable[^;]*;//g;
657 push @{ $self->_temp_classes }, $class;
660 if ($class->has_relationship($local_relname)) {
661 my $rel_cols = [ sort { $a cmp $b } apply { s/^foreign\.//i }
662 (keys %{ $class->relationship_info($local_relname)->{cond} }) ];
664 $relationship_exists = 1 if $self->_array_eq([ sort @$local_cols ], $rel_cols);
668 if (not $relationship_exists) {
669 my $colnames = q{_} . $self->_normalize_name(join '_', @$local_cols);
670 $remote_relname .= $colnames if keys %$cond > 1;
672 $local_relname = $self->_normalize_name($local_table . $colnames);
673 $local_relname =~ s/_id$//;
675 $local_relname_uninflected = $local_relname;
676 ($local_relname) = $self->_inflect_plural($local_relname);
678 # if colnames were added and this is a might_have, re-inflect
679 if ($remote_method eq 'might_have') {
680 ($local_relname) = $self->_inflect_singular($local_relname_uninflected);
685 return ($local_relname, $remote_relname, $remote_method);
689 my ($self, $relname, $method, $local_class, $local_moniker, $local_cols,
690 $remote_class, $remote_moniker, $remote_cols) = @_;
695 local_class => $local_class,
696 local_moniker => $local_moniker,
697 local_columns => $local_cols,
698 remote_class => $remote_class,
699 remote_moniker => $remote_moniker,
700 remote_columns => $remote_cols,
703 my $new_name = $relname;
705 my $map = $self->rel_name_map;
708 if ('HASH' eq ref($map)) {
709 my $name = $info->{name};
710 my $moniker = $info->{local_moniker};
711 if ($map->{$moniker} and 'HASH' eq ref($map->{$moniker})
712 and $map->{$moniker}{$name}
714 $new_name = $map->{$moniker}{$name};
717 elsif ($map->{$name} and not 'HASH' eq ref($map->{$name})) {
718 $new_name = $map->{$name};
722 elsif ('CODE' eq ref($map)) {
723 my $name = $map->($info);
730 return ($new_name, $mapped);
736 for my $class (@{ $self->_temp_classes }) {
737 Class::Unload->unload($class);
740 $self->_temp_classes([]);
745 See L<DBIx::Class::Schema::Loader/AUTHOR> and L<DBIx::Class::Schema::Loader/CONTRIBUTORS>.
749 This library is free software; you can redistribute it and/or modify it under
750 the same terms as Perl itself.
755 # vim:et sts=4 sw=4 tw=0: