overridable namespaces and overridable base resultset class

[dbsrgits/DBIx-Class.git] / lib / DBIx / Class / Schema.pm

diff --git a/lib/DBIx/Class/Schema.pm b/lib/DBIx/Class/Schema.pm
index 427faeb..105064b 100644 (file)
--- a/lib/DBIx/Class/Schema.pm
+++ b/lib/DBIx/Class/Schema.pm
@@ -278,6 +278,108 @@ sub load_classes {
   }
 }
 
+=head2 load_namespaces
+
+=over 4
+
+=item Arguments: %options?
+
+=back
+
+This is an alternative to L</load_classes> above which assumes an alternative
+layout for automatic class loading.  It assumes that all ResultSource classes
+to be loaded are underneath a sub- namespace of the schema called
+"ResultSource", and any corresponding ResultSet classes to be underneath a
+sub-namespace of the schema called "ResultSet".
+
+You can change the namespaces checked for ResultSources and ResultSets via
+the C<resultsource_namespace> and C<resultset_namespace> options, respectively.
+
+Any source which does not have an explicitly-defined corresponding ResultSet
+will have one created in the appropriate namespace for it, based on
+L<DBIx::Class::ResultSet>.  If you wish to change this default ResultSet
+base class, you can do so via the C<default_resultset_base> option.  (Your
+custom default should, of course, be based on L<DBIx::Class::ResultSet>
+itself).
+
+This method requires L<Module::Find> to be installed on the system.
+
+Example:
+
+  My::Schema->load_namespaces;
+  # loads My::Schema::ResultSource::CD, My::Schema::ResultSource::Artist,
+  #    My::Schema::ResultSet::CD, etc...
+
+  My::Schema->load_namespaces(
+    resultsource_namespace => 'My::Schema::RSources',
+    resultset_namespace => 'My::Schema::RSets',
+    default_resultset_base => 'My::Schema::RSetBase',
+  );
+  # loads My::Schema::RSources::CD, My::Schema::RSources::Artist,
+  #    My::Schema::RSets::CD, and if no such class exists on disk,
+  #    creates My::Schema::RSets::Artist in memory based on the
+  #    class My::Schema::RSetBase
+
+=cut
+
+sub load_namespaces {
+  my ($class, %args) = @_;
+
+  my $resultsource_namespace = $args{resultsource_namespace}
+                               || ($class . '::ResultSource');
+  my $resultset_namespace = $args{resultset_namespace}
+                            || ($class . '::ResultSet');
+  my $default_resultset_base = $args{default_resultset_base}
+                               || 'DBIx::Class::ResultSet';
+
+  eval "require Module::Find";
+  $class->throw_exception("Couldn't load Module::Find ($@)") if $@;
+
+  my %sources = map { (substr($_, length "${resultsource_namespace}::"), $_) }
+      Module::Find::findallmod($resultsource_namespace);
+
+  my %resultsets = map { (substr($_, length "${resultset_namespace}::"), $_) }
+      Module::Find::findallmod($resultset_namespace);
+
+  my @to_register;
+  {
+    no warnings qw/redefine/;
+    no strict qw/refs/;
+    local *Class::C3::reinitialize = sub { };
+    foreach my $source (keys %sources) {
+      my $source_class = $sources{$source};
+      $class->ensure_class_loaded($source_class);
+      $source_class->source_name($source) unless $source_class->source_name;
+      if(!$source_class->resultset_class
+         || $source_class->resultset_class eq 'DBIx::Class::ResultSet') {
+        if(my $rs_class = delete $resultsets{$source}) {
+          $class->ensure_class_loaded($rs_class);
+          $source_class->resultset_class($rs_class);
+        }
+        else {
+          my $rs_class = "$resultset_namespace\::$source";
+          @{"$rs_class\::ISA"} = ($default_resultset_base);
+          $source_class->resultset_class($rs_class);
+        }
+      }
+
+      push(@to_register, [ $source_class->source_name, $source_class ]);
+    }
+  }
+
+  foreach (keys %resultsets) {
+    warn "load_namespaces found ResultSet $_ with no "
+      . 'corresponding ResultSource';
+  }
+
+  Class::C3->reinitialize;
+
+  foreach my $to (@to_register) {
+    $class->register_class(@$to);
+    #  if $class->can('result_source_instance');
+  }
+}
+
 =head2 compose_connection
 
 =over 4
@@ -751,7 +853,7 @@ sub ddl_filename
     my ($self, $type, $dir, $version) = @_;
 
     my $filename = ref($self);
-    $filename =~ s/^.*:://;
+    $filename =~ s/::/-/;
     $filename = "$dir$filename-$version-$type.sql";
 
     return $filename;