handle column accessor collisions with UNIVERSAL methods
[dbsrgits/DBIx-Class-Schema-Loader.git] / lib / DBIx / Class / Schema / Loader / RelBuilder.pm
index adc652a..b212480 100644 (file)
@@ -2,11 +2,14 @@ package DBIx::Class::Schema::Loader::RelBuilder;
 
 use strict;
 use warnings;
-use Class::C3;
+use mro 'c3';
 use Carp::Clan qw/^DBIx::Class/;
-use Lingua::EN::Inflect::Number ();
+use Scalar::Util ();
 
-our $VERSION = '0.05003';
+use Lingua::EN::Inflect::Phrase ();
+use DBIx::Class::Schema::Loader::Utils 'split_name';
+
+our $VERSION = '0.07002';
 
 =head1 NAME
 
@@ -14,7 +17,7 @@ DBIx::Class::Schema::Loader::RelBuilder - Builds relationships for DBIx::Class::
 
 =head1 SYNOPSIS
 
-See L<DBIx::Class::Schema::Loader>
+See L<DBIx::Class::Schema::Loader> and L<DBIx::Class::Schema::Loader::Base>.
 
 =head1 DESCRIPTION
 
@@ -25,15 +28,7 @@ is module is not (yet) for external use.
 
 =head2 new
 
-Arguments: schema_class (scalar), inflect_plural, inflect_singular
-
-C<$schema_class> should be a schema class name, where the source
-classes have already been set up and registered.  Column info, primary
-key, and unique constraints will be drawn from this schema for all
-of the existing source monikers.
-
-Options inflect_plural and inflect_singular are optional, and are better documented
-in L<DBIx::Class::Schema::Loader::Base>.
+Arguments: $base object
 
 =head2 generate_code
 
@@ -75,20 +70,32 @@ arguments, like so:
 
 =cut
 
+
 sub new {
+    my ( $class, $base ) = @_;
 
-    my ( $class, $schema, $inflect_pl, $inflect_singular, $rel_attrs ) = @_;
+    # from old POD about this constructor:
+    # C<$schema_class> should be a schema class name, where the source
+    # classes have already been set up and registered.  Column info,
+    # primary key, and unique constraints will be drawn from this
+    # schema for all of the existing source monikers.
+
+    # Options inflect_plural and inflect_singular are optional, and
+    # are better documented in L<DBIx::Class::Schema::Loader::Base>.
 
     my $self = {
-        schema => $schema,
-        inflect_plural => $inflect_pl,
-        inflect_singular => $inflect_singular,
-        relationship_attrs => $rel_attrs,
+        base               => $base,
+        schema             => $base->schema,
+        inflect_plural     => $base->inflect_plural,
+        inflect_singular   => $base->inflect_singular,
+        relationship_attrs => $base->relationship_attrs,
     };
 
+    Scalar::Util::weaken $self->{base}; #< don't leak
+
     # validate the relationship_attrs arg
     if( defined $self->{relationship_attrs} ) {
-       ref($self->{relationship_attrs}) eq 'HASH'
+       ref $self->{relationship_attrs} eq 'HASH'
            or croak "relationship_attrs must be a hashref";
     }
 
@@ -100,6 +107,8 @@ sub new {
 sub _inflect_plural {
     my ($self, $relname) = @_;
 
+    return '' if !defined $relname || $relname eq '';
+
     if( ref $self->{inflect_plural} eq 'HASH' ) {
         return $self->{inflect_plural}->{$relname}
             if exists $self->{inflect_plural}->{$relname};
@@ -109,13 +118,15 @@ sub _inflect_plural {
         return $inflected if $inflected;
     }
 
-    return Lingua::EN::Inflect::Number::to_PL($relname);
+    return $self->_to_PL($relname);
 }
 
 # Singularize a relationship name
 sub _inflect_singular {
     my ($self, $relname) = @_;
 
+    return '' if !defined $relname || $relname eq '';
+
     if( ref $self->{inflect_singular} eq 'HASH' ) {
         return $self->{inflect_singular}->{$relname}
             if exists $self->{inflect_singular}->{$relname};
@@ -125,18 +136,57 @@ sub _inflect_singular {
         return $inflected if $inflected;
     }
 
-    return Lingua::EN::Inflect::Number::to_S($relname);
+    return $self->_to_S($relname);
+}
+
+sub _to_PL {
+    my ($self, $name) = @_;
+
+    $name =~ s/_/ /g;
+    my $plural = Lingua::EN::Inflect::Phrase::to_PL($name);
+    $plural =~ s/ /_/g;
+
+    return $plural;
+}
+
+sub _to_S {
+    my ($self, $name) = @_;
+
+    $name =~ s/_/ /g;
+    my $singular = Lingua::EN::Inflect::Phrase::to_S($name);
+    $singular =~ s/ /_/g;
+
+    return $singular;
 }
 
+sub _default_relationship_attrs { +{
+    has_many => {
+        cascade_delete => 0,
+        cascade_copy   => 0,
+    },
+    might_have => {
+        cascade_delete => 0,
+        cascade_copy   => 0,
+    },
+    belongs_to => {
+        on_delete => 'CASCADE',
+        on_update => 'CASCADE',
+        is_deferrable => 1,
+    },
+} }
+
 # 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
 sub _relationship_attrs {
     my ( $self, $reltype ) = @_;
     my $r = $self->{relationship_attrs};
-    return unless $r && ( $r->{all} || $r->{$reltype} );
 
-    my %composite = %{ $r->{all} || {} };
+    my %composite = (
+        %{ $self->_default_relationship_attrs->{$reltype} || {} },
+        %{ $r->{all} || {} }
+    );
+
     if( my $specific = $r->{$reltype} ) {
        while( my ($k,$v) = each %$specific ) {
            $composite{$k} = $v;
@@ -146,7 +196,7 @@ sub _relationship_attrs {
 }
 
 sub _array_eq {
-    my ($a, $b) = @_;
+    my ($self, $a, $b) = @_;
 
     return unless @$a == @$b;
 
@@ -157,19 +207,42 @@ sub _array_eq {
 }
 
 sub _remote_attrs {
-       my ($self, $local_moniker, $local_cols) = @_;
+    my ($self, $local_moniker, $local_cols) = @_;
 
-       # get our base set of attrs from _relationship_attrs, if present
-       my $attrs = $self->_relationship_attrs('belongs_to') || {};
+    # get our base set of attrs from _relationship_attrs, if present
+    my $attrs = $self->_relationship_attrs('belongs_to') || {};
 
-       # If the 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;
-       $attrs->{join_type} = 'LEFT'
-           if $nullable && !defined $attrs->{join_type};
+    # If the 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;
+    $attrs->{join_type} = 'LEFT' if $nullable && !defined $attrs->{join_type};
 
-       return $attrs;
+    return $attrs;
+}
+
+sub _sanitize_name {
+    my ($self, $name) = @_;
+
+    if (ref $name) {
+        # scalar ref for weird table name (like one containing a '.')
+        ($name = $$name) =~ s/\W+/_/g;
+    }
+    else {
+        # remove 'schema.' prefix if any
+        $name =~ s/^[^.]+\.//;
+    }
+
+    return $name;
+}
+
+sub _normalize_name {
+    my ($self, $name) = @_;
+
+    $name = $self->_sanitize_name($name);
+
+    my @words = split_name $name;
+
+    return join '_', map lc, @words;
 }
 
 sub _remote_relname {
@@ -180,11 +253,12 @@ sub _remote_relname {
     # 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$//;
         $remote_relname = $self->_inflect_singular($col);
     }
     else {
-        $remote_relname = $self->_inflect_singular(lc $remote_table);
+        $remote_relname = $self->_inflect_singular($self->_normalize_name($remote_table));
     }
 
     return $remote_relname;
@@ -224,7 +298,7 @@ sub generate_code {
         }
 
         my ( $local_relname, $remote_relname, $remote_method ) =
-            $self->_relnames_and_methods( $local_moniker, $rel, \%cond,  $uniqs, \%counters );
+            $self->_relnames_and_method( $local_moniker, $rel, \%cond,  $uniqs, \%counters );
 
         push(@{$all_code->{$local_class}},
             { method => 'belongs_to',
@@ -256,7 +330,7 @@ sub generate_code {
     return $all_code;
 }
 
-sub _relnames_and_methods {
+sub _relnames_and_method {
     my ( $self, $local_moniker, $rel, $cond, $uniqs, $counters ) = @_;
 
     my $remote_moniker = $rel->{remote_source};
@@ -269,36 +343,31 @@ sub _relnames_and_methods {
 
     # If more than one rel between this pair of tables, use the local
     # col names to distinguish
-    my $local_relname;
-    my $old_multirel_name; #< TODO: remove me
+    my ($local_relname, $local_relname_uninflected);
     if ( $counters->{$remote_moniker} > 1) {
-        my $colnames = q{_} . join(q{_}, @$local_cols);
+        my $colnames = q{_} . $self->_normalize_name(join '_', @$local_cols);
         $remote_relname .= $colnames if keys %$cond > 1;
 
-        $local_relname = lc($local_table) . $colnames;
-        $local_relname =~ s/_id$//
-            #< TODO: remove me
-            and $old_multirel_name = $self->_inflect_plural( lc($local_table) . $colnames );
-        $local_relname = $self->_inflect_plural( $local_relname );
+        $local_relname = $self->_normalize_name($local_table . $colnames);
+        $local_relname =~ s/_id$//;
 
+        $local_relname_uninflected = $local_relname;
+        $local_relname = $self->_inflect_plural($local_relname);
     } else {
-        $local_relname = $self->_inflect_plural(lc $local_table);
+        $local_relname_uninflected = $self->_normalize_name($local_table);
+        $local_relname = $self->_inflect_plural($self->_normalize_name($local_table));
     }
 
     my $remote_method = 'has_many';
 
     # If the local columns have a UNIQUE constraint, this is a one-to-one rel
     my $local_source = $self->{schema}->source($local_moniker);
-    if (_array_eq([ $local_source->primary_columns ], $local_cols) ||
-            grep { _array_eq($_->[1], $local_cols) } @$uniqs) {
+    if ($self->_array_eq([ $local_source->primary_columns ], $local_cols) ||
+            grep { $self->_array_eq($_->[1], $local_cols) } @$uniqs) {
         $remote_method = 'might_have';
-        $local_relname = $self->_inflect_singular($local_relname);
+        $local_relname = $self->_inflect_singular($local_relname_uninflected);
     }
 
-    # TODO: remove me after 0.05003 release
-    $old_multirel_name
-        and warn __PACKAGE__." $VERSION: warning, stripping trailing _id from ${remote_class} relation '$old_multirel_name', renaming to '$local_relname'.  This behavior is new as of 0.05003.\n";
-
     return ( $local_relname, $remote_relname, $remote_method );
 }
 
@@ -314,3 +383,4 @@ the same terms as Perl itself.
 =cut
 
 1;
+# vim:et sts=4 sw=4 tw=0: