Introduce GOVERNANCE document and empty RESOLUTIONS file.
[dbsrgits/DBIx-Class.git] / lib / DBIx / Class / ResultSetManager.pm
index 2cb6239..e4adae5 100644 (file)
@@ -1,46 +1,36 @@
 package DBIx::Class::ResultSetManager;
 use strict;
+use warnings;
 use base 'DBIx::Class';
-use Class::Inspector;
 
-=head1 NAME 
+use DBIx::Class::_Util qw( set_subname describe_class_methods );
+use namespace::clean;
 
-    DBIx::Class::ResultSetManager - helpful methods for managing
-    resultset classes (EXPERIMENTAL)
+warn "DBIx::Class::ResultSetManager never left experimental status and
+has now been DEPRECATED. This module will be deleted in 09000 so please
+migrate any and all code using it to explicit resultset classes using either
+__PACKAGE__->resultset_class(...) calls or by switching from using
+DBIx::Class::Schema->load_classes() to load_namespaces() and creating
+appropriate My::Schema::ResultSet::* classes for it to pick up.";
 
-=head1 SYNOPSIS
+=head1 NAME
 
-  # in a table class
-  __PACKAGE__->load_components(qw/ResultSetManager Core/); # note order!
-  __PACKAGE__->load_resultset_components(qw/AlwaysRS/);
-    
-  # will be removed from the table class and inserted into a
-  # table-specific resultset class
-  sub search_by_year_desc : ResultSet {
-    my $self = shift;
-    my $cond = shift;
-    my $attrs = shift || {};
-    $attrs->{order_by} = 'year DESC';
-    $self->next::method($cond, $attrs);
-  }
-
-  $rs = $schema->resultset('CD')->search_by_year_desc({ artist => 'Tool' });
+DBIx::Class::ResultSetManager - scheduled for deletion in 09000
 
 =head1 DESCRIPTION
 
-This package implements two useful features for customizing resultset
-classes.  C<load_resultset_components> loads components in addition to
-C<DBIx::Class::ResultSet> (or whatever you set as
-C<base_resultset_class>). Any methods tagged with the C<ResultSet>
-attribute will be moved into a table-specific resultset class (by
-default called C<Class::_resultset>, but configurable via
-C<table_resultset_class_suffix>).  Most of the magic is done when you
-call C<< __PACKAGE__->table >>.
+DBIx::Class::ResultSetManager never left experimental status and
+has now been DEPRECATED. This module will be deleted in 09000 so please
+migrate any and all code using it to explicit resultset classes using either
+__PACKAGE__->resultset_class(...) calls or by switching from using
+DBIx::Class::Schema->load_classes() to load_namespaces() and creating
+appropriate My::Schema::ResultSet::* classes for it to pick up.";
 
 =cut
 
-__PACKAGE__->mk_classdata($_)
-  for qw/ base_resultset_class table_resultset_class_suffix /;
+__PACKAGE__->mk_group_accessors(inherited => qw(
+  base_resultset_class table_resultset_class_suffix
+));
 __PACKAGE__->base_resultset_class('DBIx::Class::ResultSet');
 __PACKAGE__->table_resultset_class_suffix('::_resultset');
 
@@ -49,7 +39,7 @@ sub table {
     my $ret = $self->next::method(@rest);
     if (@rest) {
         $self->_register_attributes;
-        $self->_register_resultset_class;        
+        $self->_register_resultset_class;
     }
     return $ret;
 }
@@ -64,16 +54,23 @@ sub _register_attributes {
     my $self = shift;
     my $cache = $self->_attr_cache;
     return if keys %$cache == 0;
-    
-    foreach my $meth (@{Class::Inspector->methods($self) || []}) {
-        my $attrs = $cache->{$self->can($meth)};
-        next unless $attrs;
-        if ($attrs->[0] eq 'ResultSet') {
-            no strict 'refs';
-            my $resultset_class = $self->_setup_resultset_class;
-            *{"$resultset_class\::$meth"} = $self->can($meth);
-            delete ${"${self}::"}{$meth};
-        }
+
+    for my $meth(
+      map
+        { $_->{name} }
+        grep
+          { $_->{attributes}{ResultSet} }
+          map
+            { $_->[0] }
+            values %{ describe_class_methods( ref $self || $self )->{methods} }
+    ) {
+        # This codepath is extremely old, miht as well keep it running
+        # as-is with no room for surprises
+        no strict 'refs';
+        my $resultset_class = $self->_setup_resultset_class;
+        my $name = join '::',$resultset_class, $meth;
+        *$name = set_subname $name, $self->can($meth);
+        delete ${"${self}::"}{$meth};
     }
 }
 
@@ -91,22 +88,24 @@ sub _register_resultset_class {
     my $self = shift;
     my $resultset_class = $self . $self->table_resultset_class_suffix;
     no strict 'refs';
-    if (@{"$resultset_class\::ISA"}) {
-        $self->result_source_instance->resultset_class($resultset_class);
-    } else {
-        $self->result_source_instance->resultset_class
-         ($self->base_resultset_class);        
-    }
+    $self->result_source->resultset_class(
+      ( scalar @{"${resultset_class}::ISA"} )
+        ? $resultset_class
+        : $self->base_resultset_class
+    );
 }
 
-1;
-
-=head1 AUTHORS
+=head1 FURTHER QUESTIONS?
 
-David Kamholz <dkamholz@cpan.org>
+Check the list of L<additional DBIC resources|DBIx::Class/GETTING HELP/SUPPORT>.
 
-=head1 LICENSE
+=head1 COPYRIGHT AND LICENSE
 
-You may distribute this code under the same terms as Perl itself.
+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>.
 
 =cut
+
+1;