X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst%2FModel%2FDBIC%2FSchema.pm;h=81e4c4a18de9cb7e9b14d90c8fc9d62118f367fd;hb=ce9e19dc06c0e6df8cb3e32cca24b445b96b1031;hp=ad99846ec4101b2359d6b151c282a0fb75530145;hpb=fb691af97ffd7b3043d2d536db478af6219896f4;p=catagits%2FCatalyst-Model-DBIC-Schema.git diff --git a/lib/Catalyst/Model/DBIC/Schema.pm b/lib/Catalyst/Model/DBIC/Schema.pm index ad99846..81e4c4a 100644 --- a/lib/Catalyst/Model/DBIC/Schema.pm +++ b/lib/Catalyst/Model/DBIC/Schema.pm @@ -5,16 +5,16 @@ use mro 'c3'; extends 'Catalyst::Model'; with 'CatalystX::Component::Traits'; -our $VERSION = '0.24'; +our $VERSION = '0.32'; +$VERSION = eval $VERSION; use namespace::autoclean; use Carp::Clan '^Catalyst::Model::DBIC::Schema'; use Data::Dumper; use DBIx::Class (); -use Moose::Autobox; use Catalyst::Model::DBIC::Schema::Types - qw/ConnectInfo SchemaClass CursorClass/; + qw/ConnectInfo LoadedClass SchemaClass/; use MooseX::Types::Moose qw/ArrayRef Str ClassName Undef/; @@ -24,49 +24,35 @@ Catalyst::Model::DBIC::Schema - DBIx::Class::Schema Model Class =head1 SYNOPSIS -Manual creation of a DBIx::Class::Schema and a Catalyst::Model::DBIC::Schema: - -=over +=over 4 =item 1. -Create the DBIx:Class schema in MyApp/Schema/FilmDB.pm: +First, prepare your database schema using C. - package MyApp::Schema::FilmDB; - use base qw/DBIx::Class::Schema/; +(If you're not sure how to do this, then read L first!) - __PACKAGE__->load_classes(qw/Actor Role/); +This example assumes that you already have a schema called +C, +which defines some tables in C and +C. =item 2. -Create some classes for the tables in the database, for example an -Actor in MyApp/Schema/FilmDB/Actor.pm: - - package MyApp::Schema::FilmDB::Actor; - use base qw/DBIx::Class/ - - __PACKAGE__->load_components(qw/Core/); - __PACKAGE__->table('actor'); - - ... +Now, to expose it to Catalyst as a model, you should create a DBIC Model in +MyApp/Model/FilmDB.pm: -and a Role in MyApp/Schema/FilmDB/Role.pm: +=over 8 - package MyApp::Schema::FilmDB::Role; - use base qw/DBIx::Class/ +You can do this: - __PACKAGE__->load_components(qw/Core/); - __PACKAGE__->table('role'); +=item * With the helper script - ... + script/create.pl model FilmDB DBIC::Schema MyApp::Schema::FilmDB ...options... -Notice that the schema is in MyApp::Schema, not in MyApp::Model. This way it's -usable as a standalone module and you can test/run it without Catalyst. +See L for details. -=item 3. - -To expose it to Catalyst as a model, you should create a DBIC Model in -MyApp/Model/FilmDB.pm: +=item * Manually package MyApp::Model::FilmDB; use base qw/Catalyst::Model::DBIC::Schema/; @@ -84,47 +70,29 @@ See below for a full list of the possible config parameters. =back -Now you have a working Model which accesses your separate DBIC Schema. This can -be used/accessed in the normal Catalyst manner, via $c->model(): +=back - my $actor = $c->model('FilmDB::Actor')->find(1); +Now you have a working Model which accesses your separate DBIC Schema. This can +be used/accessed in the normal Catalyst manner, via C<< $c->model() >>: -You can also use it to set up DBIC authentication with -L in MyApp.pm: + my $db_model = $c->model('FilmDB'); # a Catalyst::Model + my $dbic = $c->model('FilmDB')->schema; # the actual DBIC object - package MyApp; +The Model proxies the DBIC instance so you can do - use Catalyst qw/... Authentication .../; + my $rs = $db_model->resultset('Actor'); # ... or ... + my $rs = $dbic ->resultset('Actor'); # same! - ... +There is also a shortcut, which returns a L directly, +instead of a L: - __PACKAGE__->config->{authentication} = - { - default_realm => 'members', - realms => { - members => { - credential => { - class => 'Password', - password_field => 'password', - password_type => 'hashed' - password_hash_type => 'SHA-256' - }, - store => { - class => 'DBIx::Class', - user_model => 'DB::User', - role_relation => 'roles', - role_field => 'rolename', - } - } - } - }; + my $rs = $c->model('FilmDB::Actor'); -C<< $c->model('Schema::Source') >> returns a L for -the source name parameter passed. To find out more about which methods can -be called on a ResultSet, or how to add your own methods to it, please see -the ResultSet documentation in the L distribution. +To find out more about which methods can be called on a ResultSet, or how to +add your own methods to it, please see the ResultSet documentation in the +L distribution. -Some examples are given below: +=head2 Some examples: # to access schema methods directly: $c->model('FilmDB')->schema->source(...); @@ -154,6 +122,8 @@ Some examples are given below: $newconn->storage_type('::LDAP'); $newconn->connection(...); +To set up authentication, see L below. + =head1 DESCRIPTION This is a Catalyst Model for L-based Models. See @@ -199,6 +169,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 Schema. It needs @@ -262,6 +234,7 @@ Or using L: on_connect_do some SQL statement on_connect_do another SQL statement + user_defined_schema_accessor foo or @@ -275,14 +248,14 @@ Or using L: 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 then L options is also @@ -384,6 +357,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. @@ -431,8 +413,6 @@ Used often for debugging and controlling transactions. =cut -has schema => (is => 'rw', isa => 'DBIx::Class::Schema'); - has schema_class => ( is => 'ro', isa => SchemaClass, @@ -442,7 +422,7 @@ has schema_class => ( 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', @@ -453,13 +433,13 @@ has model_name => ( has _default_cursor_class => ( is => 'ro', - isa => CursorClass, + isa => LoadedClass, default => 'DBIx::Class::Storage::DBI::Cursor', coerce => 1 ); sub BUILD { - my $self = shift; + my ($self, $args) = @_; my $class = $self->_original_class_name; my $schema_class = $self->schema_class; @@ -485,8 +465,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; @@ -499,13 +489,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> time before configuration, but after L is +Called at C time before configuration, but after L is set. To do something after configuuration use C<< after BUILD => >>. =cut @@ -530,8 +516,15 @@ sub _install_rs_models { my @sources = $self->schema->sources; - die "No sources found (did you forget to define your tables?)" - unless @sources; + unless (@sources) { + warn <<'EOF' unless $ENV{CMDS_NO_SOURCES}; +******************************* WARNING *************************************** +* No sources found (did you forget to define your tables?) * +* * +* To turn off this warning, set the CMDS_NO_SOURCES environment variable. * +******************************************************************************* +EOF + } foreach my $moniker (@sources) { my $classname = "${class}::$moniker"; @@ -573,8 +566,98 @@ 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 ENVIRONMENT + +=over 4 + +=item CMDS_NO_SOURCES + +Set this variable if you will be using schemas with no sources (tables) to +disable the warning. The warning is there because this is usually a mistake. + +=back + +=head1 Setting up DBIC authentication + +You can set this up with +L in MyApp.pm: + + package MyApp; + + use Catalyst qw/... Authentication .../; + + ... + + __PACKAGE__->config('Plugin::Authentication' => + { + default_realm => 'members', + members => { + credential => { + class => 'Password', + password_field => 'password', + password_type => 'hashed' + password_hash_type => 'SHA-256' + }, + store => { + class => 'DBIx::Class', + user_model => 'DB::User', + role_relation => 'roles', + role_field => 'rolename', + } + } + }); + =head1 SEE ALSO General Catalyst Stuff: @@ -586,7 +669,7 @@ Stuff related to DBIC and this Model style: L, L, L, L, -L +L, L Traits: @@ -595,15 +678,31 @@ L =head1 AUTHOR -Brandon L Black, C +Brandon L Black C + +=head1 CONTRIBUTORS + +caelum: Rafael Kitover C + +dandv: Dan Dascalescu C -Contributors: +bluefeet: Aran Deltac C -Rafael Kitover, C +t0m: Tomas Doran C + +osfameron: C + +Ozum Eldogan C =head1 COPYRIGHT -This program is free software, you can redistribute it and/or modify it +Copyright (c) 2006 - 2009 +the Catalyst::Model::DBIC::Schema L and L +as listed above. + +=head1 LICENSE + +This program is free software. You can redistribute it and/or modify it under the same terms as Perl itself. =cut