Comprehensive diagnostic on incorrect ResultSource metadata use
[dbsrgits/DBIx-Class.git] / lib / DBIx / Class / ResultSourceProxy / Table.pm
index ce78cb8..b0c4343 100644 (file)
@@ -6,11 +6,51 @@ use warnings;
 use base qw/DBIx::Class::ResultSourceProxy/;
 
 use DBIx::Class::ResultSource::Table;
-
-__PACKAGE__->mk_classdata(table_class => 'DBIx::Class::ResultSource::Table');
-
-__PACKAGE__->mk_classdata('table_alias'); # FIXME: Doesn't actually do
-                                          # anything yet!
+use Scalar::Util 'blessed';
+use namespace::clean;
+
+# FIXME - both of these *PROBABLY* need to be 'inherited_ro_instance' type
+__PACKAGE__->mk_classaccessor(table_class => 'DBIx::Class::ResultSource::Table');
+# FIXME: Doesn't actually do anything yet!
+__PACKAGE__->mk_group_accessors( inherited => 'table_alias' );
+
+sub _init_result_source_instance {
+    my $class = shift;
+
+    $class->mk_group_accessors( inherited => [ result_source_instance => '_result_source' ] )
+      unless $class->can('result_source_instance');
+
+    # might be pre-made for us courtesy of DBIC::DB::result_source_instance()
+    my $rsrc = $class->result_source_instance;
+
+    return $rsrc
+      if $rsrc and $rsrc->result_class eq $class;
+
+    my $table_class = $class->table_class;
+    $class->ensure_class_loaded($table_class);
+
+    if( $rsrc ) {
+        #
+        # NOTE! - not using clone() here and *NOT* marking source as derived
+        # from the one already existing on the class (if any)
+        #
+        $rsrc = $table_class->new({
+            %$rsrc,
+            result_class => $class,
+            source_name => undef,
+            schema => undef
+        });
+    }
+    else {
+        $rsrc = $table_class->new({
+            name            => undef,
+            result_class    => $class,
+            source_name     => undef,
+        });
+    }
+
+    $class->result_source_instance($rsrc);
+}
 
 =head1 NAME
 
@@ -36,43 +76,80 @@ Adds columns to the current class and creates accessors for them.
 =head2 table
 
   __PACKAGE__->table('tbl_name');
-  
+
 Gets or sets the table name.
 
 =cut
 
 sub table {
+  return $_[0]->result_source->name unless @_ > 1;
+
   my ($class, $table) = @_;
-  return $class->result_source_instance->name unless $table;
-  unless (ref $table) {
-    $table = $class->table_class->new({
-        $class->can('result_source_instance') ?
-          %{$class->result_source_instance} : (),
+
+  unless (blessed $table && $table->isa($class->table_class)) {
+
+    my $ancestor = $class->can('result_source_instance')
+      ? $class->result_source_instance
+      : undef
+    ;
+
+    # Folks calling ->table on a class *might* expect the name
+    # to shift everywhere, but that can't happen
+    # So what we do is mark the ancestor as "dirty"
+    # even though it will have no "derived" link to the one we
+    # will use afterwards
+    if(
+      defined $ancestor
+        and
+      $ancestor->name ne $table
+        and
+      scalar $ancestor->__derived_instances
+    ) {
+      # Trigger the "descendants are dirty" logic, without giving
+      # it an explicit externally-callable interface
+      # This is ugly as sin, but likely saner in the long run
+      local $ancestor->{__in_rsrc_setter_callstack} = 1
+        unless $ancestor->{__in_rsrc_setter_callstack};
+      my $old_name = $ancestor->name;
+      $ancestor->set_rsrc_instance_specific_attribute( name => "\0" );
+      $ancestor->set_rsrc_instance_specific_attribute( name => $old_name );
+    }
+
+
+    my $table_class = $class->table_class;
+    $class->ensure_class_loaded($table_class);
+
+
+    # NOTE! - not using clone() here and *NOT* marking source as derived
+    # from the one already existing on the class (if any)
+    # This is logically sound as we are operating at class-level, and is
+    # in fact necessary, as otherwise any base-class with a "dummy" table
+    # will be marked as an ancestor of everything
+    $table = $table_class->new({
+        %{ $ancestor || {} },
         name => $table,
         result_class => $class,
-        source_name => undef,
     });
   }
 
-  $class->mk_classdata('result_source_instance')
+  $class->mk_group_accessors( inherited => [ result_source_instance => '_result_source' ] )
     unless $class->can('result_source_instance');
 
-  $class->result_source_instance($table);
-
-  if ($class->can('schema_instance')) {
-    $class =~ m/([^:]+)$/;
-    $class->schema_instance->register_class($class, $class);
-  }
+  $class->result_source_instance($table)->name;
 }
 
+=head2 table_class
+
+  __PACKAGE__->table_class('DBIx::Class::ResultSource::Table');
+
+Gets or sets the table class used for construction and validation.
+
 =head2 has_column
 
   if ($obj->has_column($col)) { ... }
 
 Returns 1 if the class has a column of this name, 0 otherwise.
 
-=cut
-
 =head2 column_info
 
   my $info = $obj->column_info($col);
@@ -81,23 +158,23 @@ Returns the column metadata hashref for a column. For a description of
 the various types of column data in this hashref, see
 L<DBIx::Class::ResultSource/add_column>
 
-=cut
-
 =head2 columns
 
   my @column_names = $obj->columns;
 
-=cut
+=head1 FURTHER QUESTIONS?
 
-1;
+Check the list of L<additional DBIC resources|DBIx::Class/GETTING HELP/SUPPORT>.
 
-=head1 AUTHORS
+=head1 COPYRIGHT AND LICENSE
 
-Matt S. Trout <mst@shadowcatsystems.co.uk>
+This module is free software L<copyright|DBIx::Class/COPYRIGHT AND LICENSE>
+by the L<DBIx::Class (DBIC) authors|DBIx::Class/AUTHORS>. You can
+redistribute it and/or modify it under the same terms as the
+L<DBIx::Class library|DBIx::Class/COPYRIGHT AND LICENSE>.
 
-=head1 LICENSE
+=cut
 
-You may distribute this code under the same terms as Perl itself.
+1;
 
-=cut