handle column accessor collisions with UNIVERSAL methods
[dbsrgits/DBIx-Class-Schema-Loader.git] / lib / DBIx / Class / Schema / Loader / RelBuilder.pm
index 359c9a7..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";
     }
 
@@ -98,7 +105,7 @@ sub new {
 
 # pluralize a relationship name
 sub _inflect_plural {
-    my ($self, $relname, $method) = @_;
+    my ($self, $relname) = @_;
 
     return '' if !defined $relname || $relname eq '';
 
@@ -111,9 +118,7 @@ sub _inflect_plural {
         return $inflected if $inflected;
     }
 
-    $method ||= '_to_PL';
-
-    return $self->$method($relname);
+    return $self->_to_PL($relname);
 }
 
 # Singularize a relationship name
@@ -138,22 +143,20 @@ sub _to_PL {
     my ($self, $name) = @_;
 
     $name =~ s/_/ /g;
-    my $plural = Lingua::EN::Inflect::Number::to_PL($name);
+    my $plural = Lingua::EN::Inflect::Phrase::to_PL($name);
     $plural =~ s/ /_/g;
 
     return $plural;
 }
 
-sub _old_to_PL {
-    my ($self, $name) = @_;
-
-    return Lingua::EN::Inflect::Number::to_PL($name);
-}
-
 sub _to_S {
     my ($self, $name) = @_;
 
-    return Lingua::EN::Inflect::Number::to_S($name);
+    $name =~ s/_/ /g;
+    my $singular = Lingua::EN::Inflect::Phrase::to_S($name);
+    $singular =~ s/ /_/g;
+
+    return $singular;
 }
 
 sub _default_relationship_attrs { +{
@@ -168,6 +171,7 @@ sub _default_relationship_attrs { +{
     belongs_to => {
         on_delete => 'CASCADE',
         on_update => 'CASCADE',
+        is_deferrable => 1,
     },
 } }
 
@@ -192,7 +196,7 @@ sub _relationship_attrs {
 }
 
 sub _array_eq {
-    my ($a, $b) = @_;
+    my ($self, $a, $b) = @_;
 
     return unless @$a == @$b;
 
@@ -216,6 +220,31 @@ sub _remote_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 {
     my ($self, $remote_table, $cond) = @_;
 
@@ -224,12 +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 = lc $col;
+        $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;
@@ -307,48 +336,38 @@ sub _relnames_and_method {
     my $remote_moniker = $rel->{remote_source};
     my $remote_obj     = $self->{schema}->source( $remote_moniker );
     my $remote_class   = $self->{schema}->class(  $remote_moniker );
-    my $remote_relname = lc $self->_remote_relname( $remote_obj->from, $cond);
+    my $remote_relname = $self->_remote_relname( $remote_obj->from, $cond);
 
     my $local_cols  = $rel->{local_columns};
     my $local_table = $self->{schema}->source($local_moniker)->from;
 
     # If more than one rel between this pair of tables, use the local
     # col names to distinguish
-    my ($local_relname, $old_local_relname, $local_relname_uninflected, $old_local_relname_uninflected);
+    my ($local_relname, $local_relname_uninflected);
     if ( $counters->{$remote_moniker} > 1) {
-        my $colnames = lc(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 = $self->_normalize_name($local_table . $colnames);
         $local_relname =~ s/_id$//;
 
         $local_relname_uninflected = $local_relname;
-        $local_relname = $self->_inflect_plural( $local_relname );
-
-        $old_local_relname_uninflected = lc($local_table) . $colnames;
-        $old_local_relname = $self->_inflect_plural( lc($local_table) . $colnames, '_old_to_PL' );
-
+        $local_relname = $self->_inflect_plural($local_relname);
     } else {
-        $local_relname_uninflected = lc $local_table;
-        $local_relname = $self->_inflect_plural(lc $local_table);
-
-        $old_local_relname_uninflected = lc $local_table;
-        $old_local_relname = $self->_inflect_plural(lc $local_table, '_old_to_PL');
+        $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_uninflected);
-        $old_local_relname = $self->_inflect_singular($old_local_relname_uninflected);
     }
 
-    warn __PACKAGE__." $VERSION: renaming ${remote_class} relation '$old_local_relname' to '$local_relname'.  This behavior is new as of 0.05003.\n" if $old_local_relname && $local_relname ne $old_local_relname;
-
     return ( $local_relname, $remote_relname, $remote_method );
 }
 
@@ -364,3 +383,4 @@ the same terms as Perl itself.
 =cut
 
 1;
+# vim:et sts=4 sw=4 tw=0: