use BUILD's $args instead of %$self
[catagits/Catalyst-Model-DBIC-Schema.git] / lib / Catalyst / Model / DBIC / Schema.pm
index 7acec2c..0a6799a 100644 (file)
@@ -2,10 +2,10 @@ package Catalyst::Model::DBIC::Schema;
 
 use Moose;
 use mro 'c3';
-with 'MooseX::Traits';
 extends 'Catalyst::Model';
+with 'CatalystX::Component::Traits';
 
-our $VERSION = '0.24';
+our $VERSION = '0.26';
 
 use namespace::autoclean;
 use Carp::Clan '^Catalyst::Model::DBIC::Schema';
@@ -14,7 +14,7 @@ use DBIx::Class ();
 use Moose::Autobox;
 
 use Catalyst::Model::DBIC::Schema::Types
-    qw/ConnectInfo SchemaClass CursorClass/;
+    qw/ConnectInfo LoadedClass/;
 
 use MooseX::Types::Moose qw/ArrayRef Str ClassName Undef/;
 
@@ -199,6 +199,8 @@ for more info.
 
 =head1 CONFIG PARAMETERS
 
+Any options in your config not listed here are passed to your schema.
+
 =head2 schema_class
 
 This is the classname of your L<DBIx::Class::Schema> Schema.  It needs
@@ -262,6 +264,7 @@ Or using L<Config::General>:
             on_connect_do   some SQL statement
             on_connect_do   another SQL statement
         </connect_info>
+        user_defined_schema_accessor foo
     </Model::FilmDB>
 
 or
@@ -275,14 +278,14 @@ Or using L<YAML>:
 
   Model::MyDB:
       schema_class: MyDB
+      traits: Caching
       connect_info:
           dsn: dbi:Oracle:mydb
           user: mtfnpy
           password: mypass
           LongReadLen: 1000000
           LongTruncOk: 1
-          on_connect_do: [ "alter session set nls_date_format = 'YYYY-MM-DD HH24:MI:SS'" ]
-          cursor_class: 'DBIx::Class::Cursor::Cached'
+          on_connect_call: 'datetime_setup'
          quote_char: '"'
 
 The old arrayref style with hashrefs for L<DBI> then L<DBIx::Class> options is also
@@ -308,17 +311,18 @@ supported:
 
 Array of Traits to apply to the instance. Traits are L<Moose::Role>s.
 
-They are relative to the C<< MyApp::Model::DB::Trait:: >>, then the C<<
-Catalyst::Model::DBIC::Schema::Trait:: >> namespaces, unless prefixed with C<+>
+They are relative to the C<< MyApp::TraitFor::Model::DBIC::Schema:: >>, then the C<<
+Catalyst::TraitFor::Model::DBIC::Schema:: >> namespaces, unless prefixed with C<+>
 in which case they are taken to be a fully qualified name. E.g.:
 
     traits Caching
-    traits +MyApp::DB::Trait::Foo
+    traits +MyApp::TraitFor::Model::Foo
 
 A new instance is created at application time, so any consumed required
 attributes, coercions and modifiers will work.
 
-Traits are applied at L<Catalyst::Component/COMPONENT> time using L<MooseX::Traits>.
+Traits are applied at L<Catalyst::Component/COMPONENT> time using
+L<CatalystX::Component::Traits>.
 
 C<ref $self> will be an anon class if any traits are applied, C<<
 $self->_original_class_name >> will be the original class.
@@ -330,9 +334,9 @@ Traits that come with the distribution:
 
 =over 4
 
-=item L<Catalyst::Model::DBIC::Schema::Trait::Caching>
+=item L<Catalyst::TraitFor::Model::DBIC::Schema::Caching>
 
-=item L<Catalyst::Model::DBIC::Schema::Trait::Replicated>
+=item L<Catalyst::TraitFor::Model::DBIC::Schema::Replicated>
 
 =back
 
@@ -361,16 +365,18 @@ The model name L<Catalyst> uses to resolve this model, the part after
 C<::Model::> or C<::M::> in your class name. E.g. if your class name is
 C<MyApp::Model::DB> the L</model_name> will be C<DB>.
 
-=head2 _original_class_name
-
-The class name of your model before any L</traits> are applied. E.g.
-C<MyApp::Model::DB>.
-
 =head2 _default_cursor_class
 
 What to reset your L<DBIx::Class::Storage::DBI/cursor_class> to if a custom one
 doesn't work out. Defaults to L<DBIx::Class::Storage::DBI::Cursor>.
 
+=head1 ATTRIBUTES FROM L<MooseX::Traits::Pluggable>
+
+=head2 _original_class_name
+
+The class name of your model before any L</traits> are applied. E.g.
+C<MyApp::Model::DB>.
+
 =head2 _traits
 
 Unresolved arrayref of traits passed in the config.
@@ -381,6 +387,15 @@ Traits you used resolved to full class names.
 
 =head1 METHODS
 
+Methods not listed here are delegated to the connected schema used by the model
+instance, so the following are equivalent:
+
+    $c->model('DB')->schema->my_accessor('foo');
+    # or
+    $c->model('DB')->my_accessor('foo');
+
+Methods on the model take precedence over schema methods.
+
 =head2 new
 
 Instantiates the Model based on the above-documented ->config parameters.
@@ -428,18 +443,16 @@ Used often for debugging and controlling transactions.
 
 =cut
 
-has schema => (is => 'rw', isa => 'DBIx::Class::Schema');
-
 has schema_class => (
     is => 'ro',
-    isa => SchemaClass,
+    isa => LoadedClass,
     coerce => 1,
     required => 1
 );
 
 has storage_type => (is => 'rw', isa => Str);
 
-has connect_info => (is => 'ro', isa => ConnectInfo, coerce => 1);
+has connect_info => (is => 'rw', isa => ConnectInfo, coerce => 1);
 
 has model_name => (
     is => 'ro',
@@ -448,45 +461,16 @@ has model_name => (
     lazy_build => 1,
 );
 
-has _traits => (is => 'ro', isa => ArrayRef);
-has _resolved_traits => (is => 'ro', isa => ArrayRef);
-
 has _default_cursor_class => (
     is => 'ro',
-    isa => CursorClass,
+    isa => LoadedClass,
     default => 'DBIx::Class::Storage::DBI::Cursor',
     coerce => 1
 );
 
-has _original_class_name => (
-    is => 'ro',
-    required => 1,
-    isa => Str,
-    default => sub { blessed $_[0] },
-);
-
-sub COMPONENT {
-    my ($class, $app, $args) = @_;
-
-    $args = $class->merge_config_hashes($class->config, $args);
-
-    if (my $traits = delete $args->{traits}) {
-        my @traits = $class->_resolve_traits($traits->flatten);
-       return $class->new_with_traits(
-           traits => \@traits,
-           _original_class_name => $class,
-            _traits => $traits,
-            _resolved_traits => \@traits,
-           %$args
-       );
-    }
-
-    return $class->new($args);
-}
-
 sub BUILD {
-    my $self = shift;
-    my $class = ref $self;
+    my ($self, $args) = @_;
+    my $class = $self->_original_class_name;
     my $schema_class = $self->schema_class;
 
     if( !$self->connect_info ) {
@@ -511,8 +495,18 @@ sub BUILD {
 
     $self->composed_schema($schema_class->compose_namespace($class));
 
+    $self->meta->make_mutable;
+    $self->meta->add_attribute('schema',
+        is => 'rw',
+        isa => 'DBIx::Class::Schema',
+        handles => $self->_delegates
+    );
+    $self->meta->make_immutable;
+
     $self->schema($self->composed_schema->clone);
 
+    $self->_pass_options_to_schema($args);
+
     $self->schema->storage_type($self->storage_type)
         if $self->storage_type;
 
@@ -525,13 +519,9 @@ sub clone { shift->composed_schema->clone(@_); }
 
 sub connect { shift->composed_schema->connect(@_); }
 
-sub storage { shift->schema->storage(@_); }
-
-sub resultset { shift->schema->resultset(@_); }
-
 =head2 setup
 
-Called at C<BUILD>> time before configuration, but after L</connect_info> is
+Called at C<BUILD> time before configuration, but after L</connect_info> is
 set. To do something after configuuration use C<< after BUILD => >>.
 
 =cut
@@ -591,32 +581,6 @@ sub _reset_cursor_class {
     }
 }
 
-sub _resolve_traits {
-    my ($class, @names) = @_;
-    my $base  = 'Trait';
-
-    my @search_ns = grep !/^(?:Moose|Class::MOP)::/,
-        $class->meta->class_precedence_list;
-        
-    my @traits;
-
-    OUTER: for my $name (@names) {
-       if ($name =~ /^\+(.*)/) {
-           push @traits, $1;
-           next;
-       }
-       for my $ns (@search_ns) {
-           my $full = "${ns}::${base}::${name}";
-           if (eval { Class::MOP::load_class($full) }) {
-               push @traits, $full;
-               next OUTER;
-           }
-       }
-    }
-
-    return @traits;
-}
-
 sub _build_model_name {
     my $self  = shift;
     my $class = $self->_original_class_name;
@@ -625,6 +589,55 @@ sub _build_model_name {
     return $model_name;
 }
 
+sub _delegates {
+    my $self = shift;
+
+    my $schema_meta = Class::MOP::Class->initialize($self->schema_class);
+    my @schema_methods = $schema_meta->get_all_method_names;
+
+# combine with any already added by other schemas
+    my @handles = eval {
+        @{ $self->meta->find_attribute_by_name('schema')->handles }
+    };
+
+# now kill the attribute, otherwise add_attribute in BUILD will not do the right
+# thing (it clears the handles for some reason.) May be a Moose bug.
+    eval { $self->meta->remove_attribute('schema') };
+
+    my %schema_methods;
+    @schema_methods{ @schema_methods, @handles } = ();
+    @schema_methods = keys %schema_methods;
+
+    my @my_methods = $self->meta->get_all_method_names;
+    my %my_methods;
+    @my_methods{@my_methods} = ();
+
+    my @delegates;
+    for my $method (@schema_methods) {
+        push @delegates, $method unless exists $my_methods{$method};
+    }
+
+    return \@delegates;
+}
+
+sub _pass_options_to_schema {
+    my ($self, $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}) {
+            next unless $self->schema->can($opt);
+            $self->schema->$opt($self->{$opt});
+        }
+    }
+}
+
 __PACKAGE__->meta->make_immutable;
 
 =head1 SEE ALSO
@@ -638,20 +651,20 @@ Stuff related to DBIC and this Model style:
 
 L<DBIx::Class>, L<DBIx::Class::Schema>,
 L<DBIx::Class::Schema::Loader>, L<Catalyst::Helper::Model::DBIC::Schema>,
-L<MooseX::Object::Pluggable>
+L<CatalystX::Component::Traits>, L<MooseX::Traits::Pluggable>
 
 Traits:
 
-L<Catalyst::Model::DBIC::Schema::Trait::Caching>,
-L<Catalyst::Model::DBIC::Schema::Trait::Replicated>
+L<Catalyst::TraitFor::Model::DBIC::Schema::Caching>,
+L<Catalyst::TraitFor::Model::DBIC::Schema::Replicated>
 
 =head1 AUTHOR
 
-Brandon L Black, C<blblack at gmail.com>
+Brandon L Black C<blblack at gmail.com>
 
-Contributors:
+=head1 CONTRIBUTORS
 
-Rafael Kitover, C<rkitover at cpan.org>
+caelum: Rafael Kitover C<rkitover at cpan.org>
 
 =head1 COPYRIGHT