use mro 'c3';
use Carp::Clan qw/^DBIx::Class/;
use Scalar::Util 'weaken';
-use DBIx::Class::Schema::Loader::Utils qw/split_name slurp_file/;
+use DBIx::Class::Schema::Loader::Utils qw/split_name slurp_file array_eq/;
use Try::Tiny;
+use List::Util 'first';
use List::MoreUtils qw/apply uniq any/;
use namespace::clean;
use Lingua::EN::Inflect::Phrase ();
use Class::Unload ();
use Class::Inspector ();
-our $VERSION = '0.07010';
+our $VERSION = '0.07035';
# Glossary:
#
=head2 generate_code
-Arguments:
-
+Arguments:
+
[
[ local_moniker1 (scalar), fk_info1 (arrayref), uniq_info1 (arrayref) ]
[ local_moniker2 (scalar), fk_info2 (arrayref), uniq_info2 (arrayref) ]
# validate the relationship_attrs arg
if( defined $self->relationship_attrs ) {
- ref $self->relationship_attrs eq 'HASH'
- or croak "relationship_attrs must be a hashref";
+ (ref $self->relationship_attrs eq 'HASH' || ref $self->relationship_attrs eq 'CODE')
+ or croak "relationship_attrs must be a hashref or coderef";
}
return $self;
},
} }
-# accessor for options to be passed to each generated relationship
-# type. take single argument, the relationship type name, and returns
-# either a hashref (if some options are set), or nothing
+# Accessor for options to be passed to each generated relationship type. takes
+# the relationship type name and optionally any attributes from the database
+# (such as FK ON DELETE/UPDATE and DEFERRABLE clauses), and returns a
+# hashref or undef if nothing is set.
+#
+# The attributes from the database override the default attributes, which in
+# turn are overridden by user supplied attributes.
sub _relationship_attrs {
- my ( $self, $reltype ) = @_;
+ my ( $self, $reltype, $db_attrs, $params ) = @_;
my $r = $self->relationship_attrs;
my %composite = (
%{ $self->_default_relationship_attrs->{$reltype} || {} },
- %{ $r->{all} || {} }
+ %{ $db_attrs || {} },
+ (
+ ref $r eq 'HASH' ? (
+ %{ $r->{all} || {} },
+ %{ $r->{$reltype} || {} },
+ )
+ :
+ ()
+ ),
);
- if( my $specific = $r->{$reltype} ) {
- while( my ($k,$v) = each %$specific ) {
- $composite{$k} = $v;
- }
+ if (ref $r eq 'CODE') {
+ $params->{attrs} = \%composite;
+
+ my %ret = %{ $r->(%$params) || {} };
+
+ %composite = %ret if %ret;
}
- return \%composite;
+
+ return %composite ? \%composite : undef;
}
-sub _array_eq {
- my ($self, $a, $b) = @_;
+sub _strip_id_postfix {
+ my ($self, $name) = @_;
- return unless @$a == @$b;
+ $name =~ s/_?(?:id|ref|cd|code|num)\z//i;
- for (my $i = 0; $i < @$a; $i++) {
- return unless $a->[$i] eq $b->[$i];
- }
- return 1;
+ return $name;
}
sub _remote_attrs {
- my ($self, $local_moniker, $local_cols) = @_;
+ my ($self, $local_moniker, $local_cols, $fk_attrs, $params) = @_;
- # get our base set of attrs from _relationship_attrs, if present
- my $attrs = $self->_relationship_attrs('belongs_to') || {};
+ # get our set of attrs from _relationship_attrs, which uses the FK attrs if available
+ my $attrs = $self->_relationship_attrs('belongs_to', $fk_attrs, $params) || {};
- # If the referring column is nullable, make 'belongs_to' an
+ # If any referring column is nullable, make 'belongs_to' an
# outer join, unless explicitly set by relationship_attrs
- my $nullable = grep { $self->schema->source($local_moniker)->column_info($_)->{is_nullable} } @$local_cols;
+ my $nullable = first { $self->schema->source($local_moniker)->column_info($_)->{is_nullable} } @$local_cols;
$attrs->{join_type} = 'LEFT' if $nullable && !defined $attrs->{join_type};
return $attrs;
sub _sanitize_name {
my ($self, $name) = @_;
- $name =~ s/\W+/_/g;
+ $name = $self->loader->_to_identifier('relationships', $name, '_');
+
+ $name =~ s/\W+/_/g; # if naming >= 8 to_identifier takes care of it
return $name;
}
$name = $self->_sanitize_name($name);
- my @words = split_name $name;
+ my @words = split_name $name, $self->loader->_get_naming_v('relationships');
return join '_', map lc, @words;
}
# name, to make filter accessors work, but strip trailing _id
if(scalar keys %{$cond} == 1) {
my ($col) = values %{$cond};
- $col = $self->_normalize_name($col);
- $col =~ s/_id$//;
+ $col = $self->_strip_id_postfix($self->_normalize_name($col));
($remote_relname) = $self->_inflect_singular($col);
}
else {
sub generate_code {
my ($self, $tables) = @_;
-
+
# make a copy to destroy
my @tables = @$tables;
$remote_relname = $self->_resolve_relname_collision($local_moniker, $local_cols, $remote_relname);
$local_relname = $self->_resolve_relname_collision($remote_moniker, $remote_cols, $local_relname);
+ my $rel_attrs_params = {
+ rel_name => $remote_relname,
+ rel_type => $local_method,
+ local_source => $self->schema->source($local_moniker),
+ remote_source => $self->schema->source($remote_moniker),
+ local_table => $rel->{local_table},
+ local_cols => $local_cols,
+ remote_table => $rel->{remote_table},
+ remote_cols => $remote_cols,
+ };
+
push(@{$all_code->{$local_class}},
{ method => $local_method,
args => [ $remote_relname,
$remote_class,
\%cond,
- $self->_remote_attrs($local_moniker, $local_cols),
+ $self->_remote_attrs($local_moniker, $local_cols, $rel->{attrs}, $rel_attrs_params),
],
extra => {
local_class => $local_class,
delete $rev_cond{$_};
}
+ $rel_attrs_params = {
+ rel_name => $local_relname,
+ rel_type => $remote_method,
+ local_source => $self->schema->source($remote_moniker),
+ remote_source => $self->schema->source($local_moniker),
+ local_table => $rel->{remote_table},
+ local_cols => $remote_cols,
+ remote_table => $rel->{local_table},
+ remote_cols => $local_cols,
+ };
+
push(@{$all_code->{$remote_class}},
{ method => $remote_method,
args => [ $local_relname,
$local_class,
\%rev_cond,
- $self->_relationship_attrs($remote_method),
+ $self->_relationship_attrs($remote_method, {}, $rel_attrs_params),
],
extra => {
local_class => $remote_class,
}
}
+ $self->_generate_m2ms($all_code);
+
# disambiguate rels with the same name
foreach my $class (keys %$all_code) {
my $dups = $self->_duplicates($all_code->{$class});
- $self->_disambiguate($all_code->{$class}, $dups) if $dups;
+ $self->_disambiguate($all_code, $class, $dups) if $dups;
}
$self->_cleanup;
return $all_code;
}
+# Find classes with only 2 FKs which are the PK and make many_to_many bridges for them.
+sub _generate_m2ms {
+ my ($self, $all_code) = @_;
+
+ while (my ($class, $rels) = each %$all_code) {
+ next unless (grep $_->{method} eq 'belongs_to', @$rels) == 2;
+
+ my $class1_local_moniker = $rels->[0]{extra}{remote_moniker};
+ my $class1_remote_moniker = $rels->[1]{extra}{remote_moniker};
+
+ my $class2_local_moniker = $rels->[1]{extra}{remote_moniker};
+ my $class2_remote_moniker = $rels->[0]{extra}{remote_moniker};
+
+ my $class1 = $rels->[0]{args}[1];
+ my $class2 = $rels->[1]{args}[1];
+
+ my $class1_to_link_table_rel = first {
+ $_->{method} eq 'has_many' && $_->{args}[1] eq $class
+ } @{ $all_code->{$class1} };
+
+ my $class1_to_link_table_rel_name = $class1_to_link_table_rel->{args}[0];
+
+ my $class2_to_link_table_rel = first {
+ $_->{method} eq 'has_many' && $_->{args}[1] eq $class
+ } @{ $all_code->{$class2} };
+
+ my $class2_to_link_table_rel_name = $class2_to_link_table_rel->{args}[0];
+
+ my $class1_link_rel = $rels->[1]{args}[0];
+ my $class2_link_rel = $rels->[0]{args}[0];
+
+ my @class1_from_cols = apply { s/^self\.//i } values %{
+ $class1_to_link_table_rel->{args}[2]
+ };
+
+ my @class1_link_cols = apply { s/^self\.//i } values %{ $rels->[1]{args}[2] };
+
+ my @class1_to_cols = apply { s/^foreign\.//i } keys %{ $rels->[1]{args}[2] };
+
+ my @class2_from_cols = apply { s/^self\.//i } values %{
+ $class2_to_link_table_rel->{args}[2]
+ };
+
+ my @class2_link_cols = apply { s/^self\.//i } values %{ $rels->[0]{args}[2] };
+
+ my @class2_to_cols = apply { s/^foreign\.//i } keys %{ $rels->[0]{args}[2] };
+
+ my $link_moniker = $rels->[0]{extra}{local_moniker};
+
+ my @link_table_cols =
+ @{[ $self->schema->source($link_moniker)->columns ]};
+
+ my @link_table_primary_cols =
+ @{[ $self->schema->source($link_moniker)->primary_columns ]};
+
+ next unless @class1_link_cols + @class2_link_cols == @link_table_cols
+ && @link_table_cols == @link_table_primary_cols;
+
+ my ($class1_to_class2_relname) = $self->_rel_name_map(
+ ($self->_inflect_plural($class1_link_rel))[0],
+ 'many_to_many',
+ $class1,
+ $class1_local_moniker,
+ \@class1_from_cols,
+ $class2,
+ $class1_remote_moniker,
+ \@class1_to_cols,
+ {
+ link_class => $class,
+ link_moniker => $link_moniker,
+ link_rel_name => $class1_to_link_table_rel_name,
+ },
+ );
+
+ $class1_to_class2_relname = $self->_resolve_relname_collision(
+ $class1_local_moniker,
+ \@class1_from_cols,
+ $class1_to_class2_relname,
+ );
+
+ my ($class2_to_class1_relname) = $self->_rel_name_map(
+ ($self->_inflect_plural($class2_link_rel))[0],
+ 'many_to_many',
+ $class1,
+ $class2_local_moniker,
+ \@class2_from_cols,
+ $class2,
+ $class2_remote_moniker,
+ \@class2_to_cols,
+ {
+ link_class => $class,
+ link_moniker => $link_moniker,
+ link_rel_name => $class2_to_link_table_rel_name,
+ },
+ );
+
+ $class2_to_class1_relname = $self->_resolve_relname_collision(
+ $class2_local_moniker,
+ \@class2_from_cols,
+ $class2_to_class1_relname,
+ );
+
+ push @{$all_code->{$class1}}, {
+ method => 'many_to_many',
+ args => [
+ $class1_to_class2_relname,
+ $class1_to_link_table_rel_name,
+ $class1_link_rel,
+ ],
+ extra => {
+ local_class => $class1,
+ link_class => $class,
+ local_moniker => $class1_local_moniker,
+ remote_moniker => $class1_remote_moniker,
+ },
+ };
+
+ push @{$all_code->{$class2}}, {
+ method => 'many_to_many',
+ args => [
+ $class2_to_class1_relname,
+ $class2_to_link_table_rel_name,
+ $class2_link_rel,
+ ],
+ extra => {
+ local_class => $class2,
+ link_class => $class,
+ local_moniker => $class2_local_moniker,
+ remote_moniker => $class2_remote_moniker,
+ },
+ };
+ }
+}
+
sub _duplicates {
my ($self, $rels) = @_;
}
sub _disambiguate {
- my ($self, $all_rels, $dups) = @_;
+ my ($self, $all_code, $in_class, $dups) = @_;
DUP: foreach my $dup (keys %$dups) {
my @rels = @{ $dups->{$dup} };
}
foreach my $rel (@rels) {
- next if $rel->{method} eq 'belongs_to';
+ next if $rel->{method} =~ /^(?:belongs_to|many_to_many)\z/;
my @to_cols = apply { s/^foreign\.//i }
keys %{ $rel->{args}[2] };
if ((not @adjectives)
&& (grep { $_->{method} eq 'might_have'
- && $_->{args}[1] eq $to_class } @$all_rels) == 1) {
+ && $_->{args}[1] eq $to_class } @{ $all_code->{$in_class} }) == 1) {
@adjectives = 'active';
}
# Check again for duplicates, since the heuristics above may not have resolved them all.
- if ($dups = $self->_duplicates($all_rels)) {
+ if ($dups = $self->_duplicates($all_code->{$in_class})) {
foreach my $dup (keys %$dups) {
# sort by method
my @rels = map $_->[1], sort { $a->[0] <=> $b->[0] } map [
- ($_->{method} eq 'belongs_to' ? 3 : $_->{method} eq 'has_many' ? 2 : 1), $_
+ {
+ belongs_to => 3,
+ has_many => 2,
+ might_have => 1,
+ many_to_many => 0,
+ }->{$_->{method}}, $_
], @{ $dups->{$dup} };
my $rel_num = 2;
foreach my $rel (@rels[1 .. $#rels]) {
- my $inflect_type = $rel->{method} eq 'has_many' ?
+ my $inflect_type = $rel->{method} =~ /^(?:many_to_many|has_many)\z/ ?
'inflect_plural'
:
'inflect_singular';
= @{ $rel->{extra} }
{qw/local_class local_moniker remote_moniker/};
- my @from_cols = apply { s/^self\.//i }
- values %{ $rel->{args}[2] };
-
- my @to_cols = apply { s/^foreign\.//i }
- keys %{ $rel->{args}[2] };
-
- my $to_class = $rel->{args}[1];
+ my (@from_cols, @to_cols, $to_class);
+
+ if ($rel->{method} eq 'many_to_many') {
+ @from_cols = apply { s/^self\.//i } values %{
+ (first { $_->{args}[0] eq $rel->{args}[1] } @{ $all_code->{$local_class} })
+ ->{args}[2]
+ };
+ @to_cols = apply { s/^foreign\.//i } keys %{
+ (first { $_->{args}[0] eq $rel->{args}[2] }
+ @{ $all_code->{ $rel->{extra}{link_class} } })
+ ->{args}[2]
+ };
+ $to_class = $self->schema->source($remote_moniker)->result_class;
+ }
+ else {
+ @from_cols = apply { s/^self\.//i } values %{ $rel->{args}[2] };
+ @to_cols = apply { s/^foreign\.//i } keys %{ $rel->{args}[2] };
+ $to_class = $rel->{args}[1];
+ }
my ($relname_new, $inflect_mapped) =
$self->$inflect_method($relname_new_uninflected);
my $rel_name_mapped;
($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);
-
+
my $mapped = $inflect_mapped || $rel_name_mapped;
warn <<"EOF" unless $mapped;
Could not find a proper name for relationship '$relname_new' in source
'$local_moniker' for columns '@{[ join ',', @from_cols ]}'. Supply a value in
-'$inflect_type' or 'rel_name_map' for '$relname_new_uninflected' to name this
-relationship.
+'$inflect_type' for '$relname_new_uninflected' or 'rel_name_map' for
+'$relname_new' to name this relationship.
EOF
$relname_new = $self->_resolve_relname_collision($local_moniker, \@from_cols, $relname_new);
my $remote_method = 'has_many';
# If the local columns have a UNIQUE constraint, this is a one-to-one rel
- if ($self->_array_eq([ $local_source->primary_columns ], $local_cols) ||
- grep { $self->_array_eq($_->[1], $local_cols) } @$uniqs) {
+ if (array_eq([ $local_source->primary_columns ], $local_cols) ||
+ first { array_eq($_->[1], $local_cols) } @$uniqs) {
$remote_method = 'might_have';
($local_relname) = $self->_inflect_singular($local_relname_uninflected);
}
my $rel_cols = [ sort { $a cmp $b } apply { s/^foreign\.//i }
(keys %{ $class->relationship_info($local_relname)->{cond} }) ];
- $relationship_exists = 1 if $self->_array_eq([ sort @$local_cols ], $rel_cols);
+ $relationship_exists = 1 if array_eq([ sort @$local_cols ], $rel_cols);
}
}
my $colnames = q{_} . $self->_normalize_name(join '_', @$local_cols);
$remote_relname .= $colnames if keys %$cond > 1;
- $local_relname = $self->_normalize_name($local_table . $colnames);
- $local_relname =~ s/_id$//;
+ $local_relname = $self->_strip_id_postfix($self->_normalize_name($local_table . $colnames));
$local_relname_uninflected = $local_relname;
($local_relname) = $self->_inflect_plural($local_relname);
sub _rel_name_map {
my ($self, $relname, $method, $local_class, $local_moniker, $local_cols,
- $remote_class, $remote_moniker, $remote_cols) = @_;
+ $remote_class, $remote_moniker, $remote_cols, $extra) = @_;
my $info = {
+ %{$extra || {}},
name => $relname,
type => $method,
local_class => $local_class,