[Catalyst-commits] r13185 - in Catalyst-Model-DBIC-Schema/trunk: . lib/Catalyst/Helper/Model/DBIC lib/Catalyst/Model/DBIC lib/Catalyst/TraitFor/Model/DBIC/Schema t t/lib t/lib/AnotherSchemaClass t/lib/AnotherSchemaClass/ResultSet

caelum at dev.catalyst.perl.org caelum at dev.catalyst.perl.org
Wed Apr 28 12:43:21 GMT 2010


Author: caelum
Date: 2010-04-28 13:43:21 +0100 (Wed, 28 Apr 2010)
New Revision: 13185

Added:
   Catalyst-Model-DBIC-Schema/trunk/t/lib/AnotherSchemaClass/ResultSet/
   Catalyst-Model-DBIC-Schema/trunk/t/lib/AnotherSchemaClass/ResultSet/Users.pm
Modified:
   Catalyst-Model-DBIC-Schema/trunk/Changes
   Catalyst-Model-DBIC-Schema/trunk/lib/Catalyst/Helper/Model/DBIC/Schema.pm
   Catalyst-Model-DBIC-Schema/trunk/lib/Catalyst/Model/DBIC/Schema.pm
   Catalyst-Model-DBIC-Schema/trunk/lib/Catalyst/TraitFor/Model/DBIC/Schema/SchemaProxy.pm
   Catalyst-Model-DBIC-Schema/trunk/t/09schema_options.t
   Catalyst-Model-DBIC-Schema/trunk/t/lib/ASchemaClass.pm
Log:
allow configuring ResultSets through the SchemaProxy trait

Modified: Catalyst-Model-DBIC-Schema/trunk/Changes
===================================================================
--- Catalyst-Model-DBIC-Schema/trunk/Changes	2010-04-28 03:35:16 UTC (rev 13184)
+++ Catalyst-Model-DBIC-Schema/trunk/Changes	2010-04-28 12:43:21 UTC (rev 13185)
@@ -1,5 +1,8 @@
 Revision history for Perl extension Catalyst::Model::DBIC::Schema
 
+0.41  Wed Apr 28 08:42:13 EDT 2010
+        - allow configuring ResultSets using the SchemaProxy trait
+
 0.40  Wed Feb  3 23:12:16 EST 2010
         - fix Replicated trait deps
 

Modified: Catalyst-Model-DBIC-Schema/trunk/lib/Catalyst/Helper/Model/DBIC/Schema.pm
===================================================================
--- Catalyst-Model-DBIC-Schema/trunk/lib/Catalyst/Helper/Model/DBIC/Schema.pm	2010-04-28 03:35:16 UTC (rev 13184)
+++ Catalyst-Model-DBIC-Schema/trunk/lib/Catalyst/Helper/Model/DBIC/Schema.pm	2010-04-28 12:43:21 UTC (rev 13185)
@@ -4,7 +4,7 @@
 use Moose;
 no warnings 'uninitialized';
 
-our $VERSION = '0.40';
+our $VERSION = '0.41';
 $VERSION = eval $VERSION;
 
 use Carp;

Modified: Catalyst-Model-DBIC-Schema/trunk/lib/Catalyst/Model/DBIC/Schema.pm
===================================================================
--- Catalyst-Model-DBIC-Schema/trunk/lib/Catalyst/Model/DBIC/Schema.pm	2010-04-28 03:35:16 UTC (rev 13184)
+++ Catalyst-Model-DBIC-Schema/trunk/lib/Catalyst/Model/DBIC/Schema.pm	2010-04-28 12:43:21 UTC (rev 13185)
@@ -5,7 +5,7 @@
 extends 'Catalyst::Model';
 with 'CatalystX::Component::Traits';
 
-our $VERSION = '0.40';
+our $VERSION = '0.41';
 $VERSION = eval $VERSION;
 
 use namespace::autoclean;
@@ -348,6 +348,13 @@
 
 Traits you used resolved to full class names.
 
+=head1 CONFIGURING YOUR SCHEMA AND RESULTSETS
+
+See the documentation for
+L<Catalyst::TraitFor::Model::DBIC::Schema::SchemaProxy> for instructions on how
+to pass config values from your L<Catalyst> config to your
+L<DBIx::Class::Schema> and/or L<DBIx::Class::ResultSet> classes.
+
 =head1 METHODS
 
 =head2 new
@@ -401,8 +408,9 @@
 =head2 storage
 
 Provides an accessor for the connected schema's storage object.
-Used often for debugging and controlling transactions.
 
+See L<DBIx::Class::Storage> and L<DBIx::Class::Storage::DBI>.
+
 =cut
 
 has schema_class => (
@@ -432,6 +440,14 @@
 
 has schema => (is => 'rw', isa => Schema);
 
+my $app_class;
+
+before COMPONENT => sub {
+    $app_class = ref $_[1] || $_[1];
+};
+
+sub app_class { $app_class }
+
 sub BUILD {
     my ($self, $args) = @_;
     my $class = $self->_original_class_name;
@@ -660,7 +676,7 @@
 
 =head1 COPYRIGHT
 
-Copyright (c) 2006 - 2009
+Copyright (c) 2006 - 2010
 the Catalyst::Model::DBIC::Schema L</AUTHOR> and L</CONTRIBUTORS>
 as listed above.
 
@@ -672,4 +688,4 @@
 =cut
 
 1;
-# vim:sts=4 sw=4 et:
+# vim:sts=4 sw=4 et tw=80:

Modified: Catalyst-Model-DBIC-Schema/trunk/lib/Catalyst/TraitFor/Model/DBIC/Schema/SchemaProxy.pm
===================================================================
--- Catalyst-Model-DBIC-Schema/trunk/lib/Catalyst/TraitFor/Model/DBIC/Schema/SchemaProxy.pm	2010-04-28 03:35:16 UTC (rev 13184)
+++ Catalyst-Model-DBIC-Schema/trunk/lib/Catalyst/TraitFor/Model/DBIC/Schema/SchemaProxy.pm	2010-04-28 12:43:21 UTC (rev 13185)
@@ -13,12 +13,73 @@
 =head1 DESCRIPTION
 
 Allows you to call your L<DBIx::Class::Schema> methods directly on the Model
-instance, and passes config options to the C<Schema> attributes at C<BUILD>
-time.
+instance, and passes config options to your L<DBIx::Class::Schema> and
+L<DBIx::Class::ResultSet> attributes at C<BUILD> time.
 
-Methods and attributes local to your C<Model> take precedence over C<Schema>
-methods and attributes.
+Methods and attributes local to your C<Model> take precedence over
+L<DBIx::Class::Schema> or L<DBIx::Class::ResultSet> methods and attributes.
 
+=head1 CREATING SCHEMA CONFIG ATTRIBUTES
+
+To create attributes in your C<Schema.pm>, use either Moose or
+L<Class::Accessor::Grouped>, which is inherited from by all L<DBIx::Class>
+classes automatically. E.g.:
+
+    __PACKAGE__->mk_group_accessors(simple => qw/
+        config_key1
+        config_key2
+        ...
+    /);
+
+Or with L<Moose>:
+
+    use Moose;
+    has config_key1 => (is => 'rw', default => 'default_value');
+
+This code can be added after the md5sum on L<DBIx::Class::Schema::Loader>
+generated schemas.
+
+At app startup, any non-local options will be passed to these accessors, and can
+be accessed as usual via C<< $schema->config_key1 >>.
+
+These config values go into your C<Model::DB> block, along with normal config
+values.
+
+=head1 CREATING RESULTSET CONFIG ATTRIBUTES
+
+You can create classdata on L<DBIx::Class::ResultSet> classes to hold values
+from L<Catalyst> config.
+
+The code for this looks something like this:
+
+    package MySchema::ResultSet::Foo;
+
+    use base 'DBIx::Class::ResultSet';
+
+    __PACKAGE__->mk_group_accessors(inherited => qw/
+        rs_config_key1
+        rs_config_key2
+        ...
+    /);
+    __PACKAGE__->rs_config_key1('default_value');
+
+Or, if you prefer L<Moose>:
+
+    package MySchema::ResultSet::Foo;
+
+    use Moose;
+    use MooseX::NonMoose;
+    use MooseX::ClassAttribute;
+    extends 'DBIx::Class::ResultSet';
+
+    class_has rs_config_key1 => (is => 'rw', default => 'default_value');
+
+In your catalyst config, use the generated Model name as the config key, e.g.:
+
+    <Model::DB::Users>
+        strict_passwords 1
+    </Model::DB::Users>
+
 =cut
 
 after setup => sub {
@@ -43,6 +104,13 @@
     my ($self, $args) = @_;
 
     $self->_pass_options_to_schema($args);
+
+    for my $source ($self->schema->sources) {
+        my $config_key = 'Model::' . $self->model_name . '::' . $source;
+        my $config = $self->app_class->config->{$config_key};
+        next unless $config;
+        $self->_pass_options_to_resultset($source, $config);
+    }
 };
 
 sub _delegates {
@@ -89,11 +157,30 @@
     for my $opt (keys %$args) {
         if (not exists $attributes{$opt}) {
             next unless $self->schema->can($opt);
-            $self->schema->$opt($self->{$opt});
+            $self->schema->$opt($args->{$opt});
         }
     }
 }
 
+sub _pass_options_to_resultset {
+    my ($self, $source, $args) = @_;
+
+    my @attributes = map {
+        $_->init_arg || ()
+    } $self->meta->get_all_attributes;
+
+    my %attributes;
+    @attributes{@attributes} = ();
+
+    for my $opt (keys %$args) {
+        if (not exists $attributes{$opt}) {
+            my $rs_class = $self->schema->source($source)->resultset_class;
+            next unless $rs_class->can($opt);
+            $rs_class->$opt($args->{$opt});
+        }
+    }
+}
+
 =head1 SEE ALSO
 
 L<Catalyst::Model::DBIC::Schema>, L<DBIx::Class::Schema>

Modified: Catalyst-Model-DBIC-Schema/trunk/t/09schema_options.t
===================================================================
--- Catalyst-Model-DBIC-Schema/trunk/t/09schema_options.t	2010-04-28 03:35:16 UTC (rev 13184)
+++ Catalyst-Model-DBIC-Schema/trunk/t/09schema_options.t	2010-04-28 12:43:21 UTC (rev 13185)
@@ -8,8 +8,10 @@
 use Test::Exception;
 use Catalyst::Model::DBIC::Schema;
 use ASchemaClass;
+use AnotherSchemaClass;
 
-plan tests => 4;
+# reusing the same app for 2 models, gets a redefined warning
+$SIG{__WARN__} = sub { warn $_[0] unless $_[0] =~ /redefined/ };
 
 ok((my $m = instance(a_schema_option => 'mtfnpy')), 'instance');
 
@@ -19,8 +21,15 @@
 
 is $m->schema->a_schema_option, 'pass the crack pipe', 'delegation works';
 
+ok(($m = instance(schema_class => 'AnotherSchemaClass')), 'instance');
+
+is $m->resultset('Users')->rs_config_option, 'configured rs value',
+    'ResultSet option passed from config';
+
+done_testing;
+
 sub instance {
-    Catalyst::Model::DBIC::Schema->COMPONENT('MyApp', {
+    MyApp::Model::DB->COMPONENT('MyApp', {
         traits => 'SchemaProxy',
         schema_class => 'ASchemaClass',
         connect_info => ['dbi:SQLite:foo.db', '', ''],
@@ -28,4 +37,17 @@
     })
 }
 
-{ package MyApp; use Catalyst; }
+BEGIN {
+    package MyApp;
+    use Catalyst;
+    __PACKAGE__->config({
+        'Model::DB::Users' => {
+            rs_config_option => 'configured rs value',
+        },
+    });
+}
+
+{
+    package MyApp::Model::DB;
+    use base 'Catalyst::Model::DBIC::Schema';
+}

Modified: Catalyst-Model-DBIC-Schema/trunk/t/lib/ASchemaClass.pm
===================================================================
--- Catalyst-Model-DBIC-Schema/trunk/t/lib/ASchemaClass.pm	2010-04-28 03:35:16 UTC (rev 13184)
+++ Catalyst-Model-DBIC-Schema/trunk/t/lib/ASchemaClass.pm	2010-04-28 12:43:21 UTC (rev 13185)
@@ -2,8 +2,9 @@
 
 use base 'DBIx::Class::Schema';
 
-__PACKAGE__->mk_group_accessors(inherited => 'a_schema_option');
-
 __PACKAGE__->load_classes;
 
+use Moose;
+has a_schema_option => (is => 'rw');
+
 1;

Added: Catalyst-Model-DBIC-Schema/trunk/t/lib/AnotherSchemaClass/ResultSet/Users.pm
===================================================================
--- Catalyst-Model-DBIC-Schema/trunk/t/lib/AnotherSchemaClass/ResultSet/Users.pm	                        (rev 0)
+++ Catalyst-Model-DBIC-Schema/trunk/t/lib/AnotherSchemaClass/ResultSet/Users.pm	2010-04-28 12:43:21 UTC (rev 13185)
@@ -0,0 +1,11 @@
+package AnotherSchemaClass::ResultSet::Users;
+
+use strict;
+use warnings;
+use base 'DBIx::Class::ResultSet';
+
+__PACKAGE__->mk_group_accessors(inherited => qw/
+    rs_config_option
+/);
+
+1;




More information about the Catalyst-commits mailing list