handle column accessor collisions with UNIVERSAL methods
[dbsrgits/DBIx-Class-Schema-Loader.git] / lib / DBIx / Class / Schema / Loader / Base.pm
index ede47bd..84bee40 100644 (file)
@@ -3,7 +3,7 @@ package DBIx::Class::Schema::Loader::Base;
 use strict;
 use warnings;
 use base qw/Class::Accessor::Grouped Class::C3::Componentised/;
-use Class::C3;
+use mro 'c3';
 use Carp::Clan qw/^DBIx::Class/;
 use DBIx::Class::Schema::Loader::RelBuilder;
 use Data::Dump qw/ dump /;
@@ -16,14 +16,15 @@ use Lingua::EN::Inflect::Phrase qw//;
 use File::Temp qw//;
 use Class::Unload;
 use Class::Inspector ();
-use Data::Dumper::Concise;
 use Scalar::Util 'looks_like_number';
 use File::Slurp 'slurp';
-use DBIx::Class::Schema::Loader::Utils 'split_name';
-require DBIx::Class;
+use DBIx::Class::Schema::Loader::Utils qw/split_name dumper_squashed eval_without_redefine_warnings/;
+use DBIx::Class::Schema::Loader::Optional::Dependencies ();
+use Try::Tiny;
+use DBIx::Class ();
 use namespace::clean;
 
-our $VERSION = '0.07001';
+our $VERSION = '0.07002';
 
 __PACKAGE__->mk_group_ro_accessors('simple', qw/
                                 schema
@@ -51,7 +52,7 @@ __PACKAGE__->mk_group_ro_accessors('simple', qw/
                                 schema_base_class
                                 result_base_class
                                 use_moose
-                               overwrite_modifications
+                                overwrite_modifications
 
                                 relationship_attrs
 
@@ -258,10 +259,10 @@ relationship types override those set in 'all'.
 For example:
 
   relationship_attrs => {
-    belongs_to => { is_deferrable => 1 },
+    belongs_to => { is_deferrable => 0 },
   },
 
-use this to make your foreign key constraints DEFERRABLE.
+use this to turn off DEFERRABLE on your foreign key constraints.
 
 =head2 debug
 
@@ -520,6 +521,11 @@ sub new {
 
     my $self = { %args };
 
+    # don't lose undef options
+    for (values %$self) {
+        $_ = 0 unless defined $_;
+    }
+
     bless $self => $class;
 
     if (my $config_file = $self->config_file) {
@@ -544,14 +550,9 @@ sub new {
     $self->_validate_class_args;
 
     if ($self->use_moose) {
-        eval <<'EOF';
-require Moose;
-require MooseX::NonMoose;
-require namespace::autoclean;
-EOF
-        if ($@) {
+        if (not DBIx::Class::Schema::Loader::Optional::Dependencies->req_ok_for('use_moose')) {
             die sprintf "You must install the following CPAN modules to enable the use_moose option: %s.\n",
-                "Moose, MooseX::NonMoose and namespace::autoclean";
+                DBIx::Class::Schema::Loader::Optional::Dependencies->req_missing_for('use_moose');
         }
     }
 
@@ -653,22 +654,21 @@ EOF
     my $filename = $self->_get_dump_filename($self->schema_class);
     return unless -e $filename;
 
-    open(my $fh, '<', $filename)
-        or croak "Cannot open '$filename' for reading: $!";
+    my ($old_gen, $old_md5, $old_ver, $old_ts, $old_custom) =
+      $self->_parse_generated_file($filename);
 
-    my $load_classes     = 0;
-    my $result_namespace = '';
+    return unless $old_ver;
+
+    # determine if the existing schema was dumped with use_moose => 1
+    if (! defined $self->use_moose) {
+        $self->{use_moose} = 1 if $old_gen =~ /^ (?!\s*\#) use \s+ Moose/xm;
+    }
 
-    while (<$fh>) {
-        if (/^__PACKAGE__->load_classes;/) {
-            $load_classes = 1;
-        } elsif (/result_namespace => '([^']+)'/) {
-            $result_namespace = $1;
-        } elsif (my ($real_ver) =
-                /^# Created by DBIx::Class::Schema::Loader v(\d+\.\d+)/) {
+    my $load_classes = ($old_gen =~ /^__PACKAGE__->load_classes;/m) ? 1 : 0;
+    my $result_namespace = do { ($old_gen =~ /result_namespace => '([^']+)'/) ? $1 : '' };
 
-            if ($load_classes && (not defined $self->use_namespaces)) {
-                warn <<"EOF"  unless $ENV{SCHEMA_LOADER_BACKCOMPAT};
+    if ($load_classes && (not defined $self->use_namespaces)) {
+        warn <<"EOF"  unless $ENV{SCHEMA_LOADER_BACKCOMPAT};
 
 'load_classes;' static schema detected, turning off 'use_namespaces'.
 
@@ -678,39 +678,37 @@ variable to disable this warning.
 See perldoc DBIx::Class::Schema::Loader::Manual::UpgradingFromV4 for more
 details.
 EOF
-                $self->use_namespaces(0);
-            }
-            elsif ($load_classes && $self->use_namespaces) {
-                $self->_upgrading_from_load_classes(1);
-            }
-            elsif ((not $load_classes) && defined $self->use_namespaces
-                                       && (not $self->use_namespaces)) {
-                $self->_downgrading_to_load_classes(
-                    $result_namespace || 'Result'
-                );
-            }
-            elsif ((not defined $self->use_namespaces)
-                   || $self->use_namespaces) {
-                if (not $self->result_namespace) {
-                    $self->result_namespace($result_namespace || 'Result');
-                }
-                elsif ($result_namespace ne $self->result_namespace) {
-                    $self->_rewriting_result_namespace(
-                        $result_namespace || 'Result'
-                    );
-                }
-            }
+        $self->use_namespaces(0);
+    }
+    elsif ($load_classes && $self->use_namespaces) {
+        $self->_upgrading_from_load_classes(1);
+    }
+    elsif ((not $load_classes) && defined $self->use_namespaces && ! $self->use_namespaces) {
+        $self->_downgrading_to_load_classes(
+            $result_namespace || 'Result'
+        );
+    }
+    elsif ((not defined $self->use_namespaces) || $self->use_namespaces) {
+        if (not $self->result_namespace) {
+            $self->result_namespace($result_namespace || 'Result');
+        }
+        elsif ($result_namespace ne $self->result_namespace) {
+            $self->_rewriting_result_namespace(
+                $result_namespace || 'Result'
+            );
+        }
+    }
 
-            # XXX when we go past .0 this will need fixing
-            my ($v) = $real_ver =~ /([1-9])/;
-            $v = "v$v";
+    # XXX when we go past .0 this will need fixing
+    my ($v) = $old_ver =~ /([1-9])/;
+    $v = "v$v";
 
-            last if $v eq $CURRENT_V || $real_ver =~ /^0\.\d\d999/;
+    return if ($v eq $CURRENT_V || $old_ver =~ /^0\.\d\d999/);
 
-            if (not %{ $self->naming }) {
-                warn <<"EOF" unless $ENV{SCHEMA_LOADER_BACKCOMPAT};
+    if (not %{ $self->naming }) {
+        warn <<"EOF" unless $ENV{SCHEMA_LOADER_BACKCOMPAT};
 
-Version $real_ver static schema detected, turning on backcompat mode.
+Version $old_ver static schema detected, turning on backcompat mode.
 
 Set the 'naming' attribute or the SCHEMA_LOADER_BACKCOMPAT environment variable
 to disable this warning.
@@ -720,28 +718,22 @@ See: 'naming' in perldoc DBIx::Class::Schema::Loader::Base .
 See perldoc DBIx::Class::Schema::Loader::Manual::UpgradingFromV4 if upgrading
 from version 0.04006.
 EOF
-            }
-            else {
-                $self->_upgrading_from($v);
-                last;
-            }
-
-            $self->naming->{relationships}    ||= $v;
-            $self->naming->{monikers}         ||= $v;
-            $self->naming->{column_accessors} ||= $v;
 
-            $self->schema_version_to_dump($real_ver);
+        $self->naming->{relationships}    ||= $v;
+        $self->naming->{monikers}         ||= $v;
+        $self->naming->{column_accessors} ||= $v;
 
-            last;
-        }
+        $self->schema_version_to_dump($old_ver);
+    }
+    else {
+        $self->_upgrading_from($v);
     }
-    close $fh;
 }
 
 sub _validate_class_args {
     my $self = shift;
     my $args = shift;
-    
+
     foreach my $k (@CLASS_ARGS) {
         next unless $self->$k;
 
@@ -852,14 +844,7 @@ sub _load_external {
         $code = $self->_rewrite_old_classnames($code);
 
         if ($self->dynamic) { # load the class too
-            # kill redefined warnings
-            my $warn_handler = $SIG{__WARN__} || sub { warn @_ };
-            local $SIG{__WARN__} = sub {
-                $warn_handler->(@_)
-                    unless $_[0] =~ /^Subroutine \S+ redefined/;
-            };
-            eval $code;
-            die $@ if $@;
+            eval_without_redefine_warnings($code);
         }
 
         $self->_ext_stmt($class,
@@ -900,14 +885,7 @@ been used by an older version of the Loader.
 * PLEASE RENAME THIS CLASS: from '$old_class' to '$class', as that is the
 new name of the Result.
 EOF
-            # kill redefined warnings
-            my $warn_handler = $SIG{__WARN__} || sub { warn @_ };
-            local $SIG{__WARN__} = sub {
-                $warn_handler->(@_)
-                    unless $_[0] =~ /^Subroutine \S+ redefined/;
-            };
-            eval $code;
-            die $@ if $@;
+            eval_without_redefine_warnings($code);
         }
 
         chomp $code;
@@ -976,46 +954,26 @@ sub rescan {
 }
 
 sub _relbuilder {
-    no warnings 'uninitialized';
     my ($self) = @_;
 
     return if $self->{skip_relationships};
 
-    if ($self->naming->{relationships} eq 'v4') {
-        require DBIx::Class::Schema::Loader::RelBuilder::Compat::v0_040;
-        return $self->{relbuilder} ||=
-            DBIx::Class::Schema::Loader::RelBuilder::Compat::v0_040->new(
-                $self->schema,
-                $self->inflect_plural,
-                $self->inflect_singular,
-                $self->relationship_attrs,
-            );
-    }
-    elsif ($self->naming->{relationships} eq 'v5') {
-        require DBIx::Class::Schema::Loader::RelBuilder::Compat::v0_05;
-        return $self->{relbuilder} ||= DBIx::Class::Schema::Loader::RelBuilder::Compat::v0_05->new (
-             $self->schema,
-             $self->inflect_plural,
-             $self->inflect_singular,
-             $self->relationship_attrs,
-        );
-    }
-    elsif ($self->naming->{relationships} eq 'v6') {
-        require DBIx::Class::Schema::Loader::RelBuilder::Compat::v0_06;
-        return $self->{relbuilder} ||= DBIx::Class::Schema::Loader::RelBuilder::Compat::v0_06->new (
-             $self->schema,
-             $self->inflect_plural,
-             $self->inflect_singular,
-             $self->relationship_attrs,
-        );
-    }
+    return $self->{relbuilder} ||= do {
 
-    return $self->{relbuilder} ||= DBIx::Class::Schema::Loader::RelBuilder->new (
-             $self->schema,
-             $self->inflect_plural,
-             $self->inflect_singular,
-             $self->relationship_attrs,
-    );
+        no warnings 'uninitialized';
+        my $relbuilder_suff =
+            {qw{
+                v4  ::Compat::v0_040
+                v5  ::Compat::v0_05
+                v6  ::Compat::v0_06
+            }}
+            ->{ $self->naming->{relationships}};
+
+        my $relbuilder_class = 'DBIx::Class::Schema::Loader::RelBuilder'.$relbuilder_suff;
+        eval "require $relbuilder_class"; die $@ if $@;
+        $relbuilder_class->new( $self );
+
+    };
 }
 
 sub _load_tables {
@@ -1104,11 +1062,11 @@ sub _reload_classes {
         
         {
             no warnings 'redefine';
-            local *Class::C3::reinitialize = sub {};
+            local *Class::C3::reinitialize = sub {};  # to speed things up, reinitialized below
             use warnings;
 
-            if ($class->can('meta') && (ref $class->meta)->isa('Moose::Meta::Class')) {
-                $class->meta->make_mutable;
+            if (my $mc = $self->_moose_metaclass($class)) {
+                $mc->make_mutable;
             }
             Class::Unload->unload($class) if $unload;
             my ($source, $resultset_class);
@@ -1118,8 +1076,8 @@ sub _reload_classes {
                 && ($resultset_class ne 'DBIx::Class::ResultSet')
             ) {
                 my $has_file = Class::Inspector->loaded_filename($resultset_class);
-                if ($resultset_class->can('meta') && (ref $resultset_class->meta)->isa('Moose::Meta::Class')) {
-                    $resultset_class->meta->make_mutable;
+                if (my $mc = $self->_moose_metaclass($resultset_class)) {
+                    $mc->make_mutable;
                 }
                 Class::Unload->unload($resultset_class) if $unload;
                 $self->_reload_class($resultset_class) if $has_file;
@@ -1135,6 +1093,15 @@ sub _reload_classes {
     }
 }
 
+sub _moose_metaclass {
+  return undef unless $INC{'Class/MOP.pm'};   # if CMOP is not loaded the class could not have loaded in the 1st place
+
+  my $mc = Class::MOP::class_of($_[1])
+    or return undef;
+
+  return $mc->isa('Moose::Meta::Class') ? $mc : undef;
+}
+
 # We use this instead of ensure_class_loaded when there are package symbols we
 # want to preserve.
 sub _reload_class {
@@ -1144,12 +1111,9 @@ sub _reload_class {
     delete $INC{ $class_path };
 
 # kill redefined warnings
-    my $warn_handler = $SIG{__WARN__} || sub { warn @_ };
-    local $SIG{__WARN__} = sub {
-        $warn_handler->(@_)
-            unless $_[0] =~ /^Subroutine \S+ redefined/;
+    eval {
+        eval_without_redefine_warnings ("require $class");
     };
-    eval "require $class;";
     die "Failed to reload class $class: $@" if $@;
 }
 
@@ -1288,44 +1252,55 @@ sub _write_classfile {
         warn "Deleting existing file '$filename' due to "
             . "'really_erase_my_files' setting\n" unless $self->{quiet};
         unlink($filename);
-    }    
+    }
 
-    my ($custom_content, $old_md5, $old_ver, $old_ts) = $self->_get_custom_content($class, $filename);
+    my ($old_gen, $old_md5, $old_ver, $old_ts, $old_custom)
+        = $self->_parse_generated_file($filename);
 
-    # If upgrading to use_moose=1 replace default custom content with default Moose custom content.
-    # If there is already custom content, which does not have the Moose content, add it.
-    if ($self->use_moose) {
-        local $self->{use_moose} = 0;
+    if (! $old_gen && -f $filename) {
+        croak "Cannot overwrite '$filename' without 'really_erase_my_files',"
+            . " it does not appear to have been generated by Loader"
+    }
 
-        if ($custom_content eq $self->_default_custom_content) {
-            local $self->{use_moose} = 1;
+    my $custom_content = $old_custom || '';
 
-            $custom_content = $self->_default_custom_content;
-        }
-        else {
-            local $self->{use_moose} = 1;
+    # prepend extra custom content from a *renamed* class (singularization effect)
+    if (my $renamed_class = $self->_upgrading_classes->{$class}) {
+        my $old_filename = $self->_get_dump_filename($renamed_class);
 
-            if ($custom_content !~ /\Q@{[$self->_default_moose_custom_content]}\E/) {
-                $custom_content .= $self->_default_custom_content;
-            }
+        if (-f $old_filename) {
+            my $extra_custom = ($self->_parse_generated_file ($old_filename))[4];
+
+            $extra_custom =~ s/\n\n# You can replace.*\n1;\n//;
+
+            $custom_content = join ("\n", '', $extra_custom, $custom_content)
+                if $extra_custom;
+
+            unlink $old_filename;
         }
     }
 
-    if (my $old_class = $self->_upgrading_classes->{$class}) {
-        my $old_filename = $self->_get_dump_filename($old_class);
+    $custom_content ||= $self->_default_custom_content;
 
-        my ($old_custom_content) = $self->_get_custom_content(
-            $old_class, $old_filename, 0 # do not add default comment
-        );
+    # If upgrading to use_moose=1 replace default custom content with default Moose custom content.
+    # If there is already custom content, which does not have the Moose content, add it.
+    if ($self->use_moose) {
 
-        $old_custom_content =~ s/\n\n# You can replace.*\n1;\n//;
+        my $non_moose_custom_content = do {
+            local $self->{use_moose} = 0;
+            $self->_default_custom_content;
+        };
 
-        if ($old_custom_content) {
-            $custom_content =
-                "\n" . $old_custom_content . "\n" . $custom_content;
+        if ($custom_content eq $non_moose_custom_content) {
+            $custom_content = $self->_default_custom_content;
+        }
+        elsif ($custom_content !~ /\Q@{[$self->_default_moose_custom_content]}\E/) {
+            $custom_content .= $self->_default_custom_content;
         }
-
-        unlink $old_filename;
+    }
+    elsif (defined $self->use_moose && $old_gen) {
+        croak 'It is not possible to "downgrade" a schema that was loaded with use_moose => 1 to use_moose => 0, due to differing custom content'
+            if $old_gen =~ /use \s+ MooseX?\b/x;
     }
 
     $custom_content = $self->_rewrite_old_classnames($custom_content);
@@ -1338,8 +1313,6 @@ sub _write_classfile {
     my $compare_to;
     if ($old_md5) {
       $compare_to = $text . $self->_sig_comment($old_ver, $old_ts);
-      
-
       if (Digest::MD5::md5_base64($compare_to) eq $old_md5) {
         return unless $self->_upgrading_from && $is_schema;
       }
@@ -1374,7 +1347,7 @@ sub _default_moose_custom_content {
 sub _default_custom_content {
     my $self = shift;
     my $default = qq|\n\n# You can replace this text with custom|
-         . qq| content, and it will be preserved on regeneration|;
+         . qq| code or comments, and it will be preserved on regeneration|;
     if ($self->use_moose) {
         $default .= $self->_default_moose_custom_content;
     }
@@ -1382,48 +1355,43 @@ sub _default_custom_content {
     return $default;
 }
 
-sub _get_custom_content {
-    my ($self, $class, $filename, $add_default) = @_;
+sub _parse_generated_file {
+    my ($self, $fn) = @_;
 
-    $add_default = 1 unless defined $add_default;
+    return unless -f $fn;
 
-    return ($self->_default_custom_content) if ! -f $filename;
+    open(my $fh, '<', $fn)
+        or croak "Cannot open '$fn' for reading: $!";
 
-    open(my $fh, '<', $filename)
-        or croak "Cannot open '$filename' for reading: $!";
-
-    my $mark_re = 
+    my $mark_re =
         qr{^(# DO NOT MODIFY THIS OR ANYTHING ABOVE! md5sum:)([A-Za-z0-9/+]{22})\n};
 
-    my $buffer = '';
-    my ($md5, $ts, $ver);
+    my ($md5, $ts, $ver, $gen);
     while(<$fh>) {
-        if(!$md5 && /$mark_re/) {
+        if(/$mark_re/) {
+            my $pre_md5 = $1;
             $md5 = $2;
-            my $line = $1;
 
-            # Pull out the previous version and timestamp
-            ($ver, $ts) = $buffer =~ m/# Created by DBIx::Class::Schema::Loader v(.*?) @ (.*?)$/s;
+            # Pull out the version and timestamp from the line above
+            ($ver, $ts) = $gen =~ m/^# Created by DBIx::Class::Schema::Loader v(.*?) @ (.*?)\Z/m;
 
-            $buffer .= $line;
-            croak "Checksum mismatch in '$filename', the auto-generated part of the file has been modified outside of this loader.  Aborting.\nIf you want to overwrite these modifications, set the 'overwrite_modifications' loader option.\n"
-                if !$self->overwrite_modifications && Digest::MD5::md5_base64($buffer) ne $md5;
+            $gen .= $pre_md5;
+            croak "Checksum mismatch in '$fn', the auto-generated part of the file has been modified outside of this loader.  Aborting.\nIf you want to overwrite these modifications, set the 'overwrite_modifications' loader option.\n"
+                if !$self->overwrite_modifications && Digest::MD5::md5_base64($gen) ne $md5;
 
-            $buffer = '';
+            last;
         }
         else {
-            $buffer .= $_;
+            $gen .= $_;
         }
     }
 
-    croak "Cannot not overwrite '$filename' without 'really_erase_my_files',"
-        . " it does not appear to have been generated by Loader"
-            if !$md5;
+    my $custom = do { local $/; <$fh> }
+        if $md5;
 
-    # Default custom content:
-    $buffer ||= $self->_default_custom_content if $add_default;
+    close ($fh);
 
-    return ($buffer, $md5, $ver, $ts);
+    return ($gen, $md5, $ver, $ts, $custom);
 }
 
 sub _use {
@@ -1544,6 +1512,7 @@ sub _resolve_col_accessor_collisions {
         die $@ if $@;
 
         push @methods, @{ Class::Inspector->methods($class) || [] };
+        push @methods, @{ Class::Inspector->methods('UNIVERSAL') || [] };
     }
 
     my %methods;
@@ -1814,33 +1783,25 @@ sub _make_pod {
     } elsif ( $method eq 'add_columns' ) {
         $self->_pod( $class, "=head1 ACCESSORS" );
         my $col_counter = 0;
-       my @cols = @_;
+        my @cols = @_;
         while( my ($name,$attrs) = splice @cols,0,2 ) {
-           $col_counter++;
+            $col_counter++;
             $self->_pod( $class, '=head2 ' . $name  );
-           $self->_pod( $class,
-                        join "\n", map {
-                            my $s = $attrs->{$_};
-                            $s = !defined $s         ? 'undef'          :
-                                  length($s) == 0     ? '(empty string)' :
-                                  ref($s) eq 'SCALAR' ? $$s :
-                                  ref($s)             ? do {
-                                                        my $dd = Dumper;
-                                                        $dd->Indent(0);
-                                                        $dd->Values([$s]);
-                                                        $dd->Dump;
-                                                      } :
-                                  looks_like_number($s) ? $s :
-                                                        qq{'$s'}
-                                  ;
-
-                            "  $_: $s"
-                        } sort keys %$attrs,
-                      );
-
-           if (my $comment = $self->__column_comment($self->{_class2table}{$class}, $col_counter)) {
-               $self->_pod( $class, $comment );
-           }
+            $self->_pod( $class,
+                join "\n", map {
+                    my $s = $attrs->{$_};
+                    $s = !defined $s          ? 'undef'             :
+                        length($s) == 0       ? '(empty string)'    :
+                        ref($s) eq 'SCALAR'   ? $$s                 :
+                        ref($s)               ? dumper_squashed $s  :
+                        looks_like_number($s) ? $s                  : qq{'$s'};
+
+                    "  $_: $s"
+                 } sort keys %$attrs,
+            );
+            if (my $comment = $self->__column_comment($self->{_class2table}{$class}, $col_counter, $name)) {
+                $self->_pod( $class, $comment );
+            }
         }
         $self->_pod_cut( $class );
     } elsif ( $method =~ /^(belongs_to|has_many|might_have)$/ ) {