package Catalyst::Model::DBIC::Schema;
-use strict;
-use warnings;
-no warnings 'uninitialized';
+use Moose;
+use mro 'c3';
+extends 'Catalyst::Model';
+with 'MooseX::Object::Pluggable';
our $VERSION = '0.24';
-use parent qw/Catalyst::Model Class::Accessor::Fast Class::Data::Accessor/;
-use MRO::Compat;
-use mro 'c3';
-use UNIVERSAL::require;
-use Carp;
+use Carp::Clan '^Catalyst::Model::DBIC::Schema';
use Data::Dumper;
use DBIx::Class ();
use Scalar::Util 'reftype';
-use namespace::clean -except => 'meta';
+use MooseX::ClassAttribute;
+use Moose::Autobox;
-__PACKAGE__->mk_classaccessor('composed_schema');
-__PACKAGE__->mk_accessors(qw/
- schema connect_info schema_class storage_type caching model_name
-/);
+use Catalyst::Model::DBIC::Schema::Types
+ qw/ConnectInfo SchemaClass CursorClass/;
+
+use MooseX::Types::Moose qw/ArrayRef Str ClassName/;
+
+use namespace::clean -except => 'meta';
=head1 NAME
=head1 CONFIG PARAMETERS
-=over 4
-
-=item schema_class
+=head2 schema_class
This is the classname of your L<DBIx::Class::Schema> Schema. It needs
to be findable in C<@INC>, but it does not need to be inside the
C<Catalyst::Model::> namespace. This parameter is required.
-=item connect_info
+=head2 connect_info
This is an arrayref of connection parameters, which are specific to your
C<storage_type> (see your storage type documentation for more details).
<Model::FilmDB>
schema_class MyApp::Schema::FilmDB
+ roles Caching
<connect_info>
dsn dbi:Pg:dbname=mypgdb
user postgres
password ''
auto_savepoint 1
+ quote_char """
on_connect_do some SQL statement
on_connect_do another SQL statement
</connect_info>
LongTruncOk: 1
on_connect_do: [ "alter session set nls_date_format = 'YYYY-MM-DD HH24:MI:SS'" ]
cursor_class: 'DBIx::Class::Cursor::Cached'
+ quote_char: '"'
The old arrayref style with hashrefs for L<DBI> then L<DBIx::Class> options is also
supported:
pg_enable_utf8 => 1,
},
{
+ auto_savepoint => 1,
on_connect_do => [
'some SQL statement',
'another SQL statement',
}
]
-=item caching
+=head2 roles
+
+Array of Roles to apply at BUILD time. Roles are relative to the
+C<<MyApp::Model::DB::Role::> then C<<Catalyst::Model::DBIC::Schema::Role::>>
+namespaces, unless prefixed with C<+> in which case they are taken to be a
+fully qualified name. E.g.:
+
+ roles Caching
+ roles +MyApp::DB::Role::Foo
+
+This is done using L<MooseX::Object::Pluggable>.
-Whether or not to enable caching support using L<DBIx::Class::Cursor::Cached>
-and L<Catalyst::Plugin::Cache>. Enabled by default.
+A new instance is created at application time, so any consumed required
+attributes, coercions and modifiers will work.
-In order for this to work, L<Catalyst::Plugin::Cache> must be configured and
-loaded. A possible configuration would look like this:
+Roles are applied before setup, schema and connection are set.
- <Plugin::Cache>
- <backend>
- class Cache::FastMmap
- unlink_on_exit 1
- </backend>
- </Plugin::Cache>
+C<ref $self> will be an anon class if any roles are applied.
-Then in your queries, set the C<cache_for> ResultSet attribute to the number of
-seconds you want the query results to be cached for, eg.:
+You cannot modify C<new> or C<BUILD>, modify C<setup> instead.
- $c->model('DB::Table')->search({ foo => 'bar' }, { cache_for => 18000 });
+L</ACCEPT_CONTEXT> and L</finalize> can also be modified.
-=item storage_type
+Roles that come with the distribution:
+
+=over 4
+
+=item L<Catalyst::Model::DBIC::Schema::Role::Caching>
+
+=item L<Catalyst::Model::DBIC::Schema::Role::Replicated>
+
+=back
+
+=head2 storage_type
Allows the use of a different C<storage_type> than what is set in your
C<schema_class> (which in turn defaults to C<::DBI> if not set in current
L<DBIx::Class>). Completely optional, and probably unnecessary for most
people until other storage backends become available for L<DBIx::Class>.
-=back
-
=head1 METHODS
-=over 4
-
-=item new
+=head2 new
Instantiates the Model based on the above-documented ->config parameters.
The only required parameter is C<schema_class>. C<connect_info> is
required in the case that C<schema_class> does not already have connection
information defined for it.
-=item schema
+=head2 schema
Accessor which returns the connected schema being used by the this model.
There are direct shortcuts on the model class itself for
schema->resultset, schema->source, and schema->class.
-=item composed_schema
+=head2 composed_schema
Accessor which returns the composed schema, which has no connection info,
which was used in constructing the C<schema> above. Useful for creating
new connections based on the same schema/model. There are direct shortcuts
from the model object for composed_schema->clone and composed_schema->connect
-=item clone
+=head2 clone
Shortcut for ->composed_schema->clone
-=item connect
+=head2 connect
Shortcut for ->composed_schema->connect
-=item source
+=head2 source
Shortcut for ->schema->source
-=item class
+=head2 class
Shortcut for ->schema->class
-=item resultset
+=head2 resultset
Shortcut for ->schema->resultset
-=item storage
+=head2 storage
Provides an accessor for the connected schema's storage object.
Used often for debugging and controlling transactions.
=cut
-sub new {
- my $self = shift->next::method(@_);
-
+class_has 'composed_schema' => (is => 'rw', isa => 'DBIx::Class::Schema');
+
+has 'schema' => (is => 'rw', isa => 'DBIx::Class::Schema');
+
+has 'schema_class' => (
+ is => 'ro',
+ isa => SchemaClass,
+ coerce => 1,
+ required => 1
+);
+
+has 'storage_type' => (is => 'rw', isa => Str);
+
+has 'connect_info' => (is => 'ro', isa => ConnectInfo, coerce => 1);
+
+# ref $self changes to anon after roles are applied, and _original_class_name is
+# broken in MX::O::P 0.0009
+has '_class_name' => (is => 'ro', isa => ClassName, default => sub {
+ ref shift
+});
+
+has 'model_name' => (is => 'ro', isa => Str, default => sub {
+ my $self = shift;
+
my $class = ref $self;
+ (my $model_name = $class) =~ s/^[\w:]+::(?:Model|M):://;
- $self->_build_model_name;
+ $model_name
+});
- croak "->config->{schema_class} must be defined for this model"
- unless $self->schema_class;
+has 'roles' => (is => 'ro', isa => ArrayRef|Str);
- my $schema_class = $self->schema_class;
+has '_default_cursor_class' => (
+ is => 'ro',
+ isa => CursorClass,
+ default => 'DBIx::Class::Storage::DBI::Cursor',
+ coerce => 1
+);
- $schema_class->require
- or croak "Cannot load schema class '$schema_class': $@";
+sub BUILD {
+ my $self = shift;
+ my $class = ref $self;
+ my $schema_class = $self->schema_class;
if( !$self->connect_info ) {
if($schema_class->storage && $schema_class->storage->connect_info) {
$self->connect_info($schema_class->storage->connect_info);
}
else {
- croak "Either ->config->{connect_info} must be defined for $class"
+ die "Either ->config->{connect_info} must be defined for $class"
. " or $schema_class must have connect info defined on it."
. " Here's what we got:\n"
. Dumper($self);
}
}
+ if (exists $self->connect_info->{cursor_class}) {
+ eval { Class::MOP::load_class($self->connect_info->{cursor_class}) }
+ or croak "invalid connect_info: Cannot load your cursor_class"
+ . " ".$self->connect_info->{cursor_class}.": $@";
+ }
+
+ $self->_plugin_ns('Role');
+
+ $self->load_plugins($self->roles->flatten) if $self->roles;
+
+ $self->setup;
+
$self->composed_schema($schema_class->compose_namespace($class));
$self->schema($self->composed_schema->clone);
$self->schema->storage_type($self->storage_type)
if $self->storage_type;
- $self->_normalize_connect_info;
-
- $self->_setup_caching;
-
$self->schema->connection($self->connect_info);
$self->_install_rs_models;
- return $self;
+ $self->finalize;
}
sub clone { shift->composed_schema->clone(@_); }
sub storage { shift->schema->storage(@_); }
-=item ACCEPT_CONTEXT
+=head2 setup
-Sets up runtime cache support on $c->model invocation.
+Called at C<<BUILD>> time before configuration.
=cut
-sub ACCEPT_CONTEXT {
- my ($self, $c) = @_;
-
- return $self unless
- $self->caching;
-
- unless ($c->can('cache') && ref $c->cache) {
- $c->log->debug("DBIx::Class cursor caching disabled, you don't seem to"
- . " have a working Cache plugin.");
- $self->caching(0);
- $self->_reset_cursor_class;
- return $self;
- }
+sub setup { 1 }
- if (ref $self->schema->default_resultset_attributes) {
- $self->schema->default_resultset_attributes->{cache_object} =
- $c->cache;
- } else {
- $self->schema->default_resultset_attributes({
- cache_object => $c->cache
- });
- }
-
- $self;
-}
-
-sub _normalize_connect_info {
- my $self = shift;
-
- my $connect_info = $self->connect_info;
+=head2 finalize
- my @connect_info = reftype $connect_info eq 'ARRAY' ?
- @$connect_info : $connect_info;
+Called at the end of C<BUILD> after everything has been configured.
- my %connect_info;
+=cut
- if (!ref $connect_info[0]) { # array style
- @connect_info{qw/dsn user password/} =
- splice @connect_info, 0, 3;
+sub finalize { 1 }
- for my $i (0..1) {
- my $extra = shift @connect_info;
- last unless $extra;
- croak "invalid connect_info" unless reftype $extra eq 'HASH';
+=head2 ACCEPT_CONTEXT
- %connect_info = (%connect_info, %$extra);
- }
+Point of extension for doing things at C<<$c->model>> time, returns the model
+instance, see L<Catalyst::Manual::Intro> for more information.
- croak "invalid connect_info" if @connect_info;
- } elsif (@connect_info == 1 && reftype $connect_info[0] eq 'HASH') {
- %connect_info = %{ $connect_info[0] };
- } elsif (reftype $connect_info eq 'HASH') {
- %connect_info = %$connect_info;
- } else {
- croak "invalid connect_info";
- }
-
- if (exists $connect_info{cursor_class}) {
- $connect_info{cursor_class}->require
- or croak "invalid connect_info: Cannot load your cursor_class"
- . " $connect_info{cursor_class}: $@";
- }
+=cut
- $self->connect_info(\%connect_info);
-}
+sub ACCEPT_CONTEXT { shift }
sub _install_rs_models {
my $self = shift;
- my $class = ref $self;
+ my $class = $self->_class_name;
no strict 'refs';
- foreach my $moniker ($self->schema->sources) {
+
+ my @sources = $self->schema->sources;
+
+ die "No sources found (did you forget to define your tables?)"
+ unless @sources;
+
+ foreach my $moniker (@sources) {
my $classname = "${class}::$moniker";
*{"${classname}::ACCEPT_CONTEXT"} = sub {
shift;
}
}
-sub _build_model_name {
- my $self = shift;
-
- my $class = ref $self;
- my $model_name = $class;
- $model_name =~ s/^[\w:]+::(?:Model|M):://;
-
- $self->model_name($model_name);
-}
-
-sub _setup_caching {
- my $self = shift;
-
- return if defined $self->caching && !$self->caching;
-
- $self->caching(0);
-
- if (my $cursor_class = $self->connect_info->{cursor_class}) {
- unless ($cursor_class->can('clear_cache')) {
- carp "Caching disabled, cursor_class $cursor_class does not"
- . " support it.";
- return;
- }
- } else {
- my $cursor_class = 'DBIx::Class::Cursor::Cached';
-
- unless ($cursor_class->require) {
- carp "Caching disabled, cannot load $cursor_class: $@";
- return;
- }
-
- $self->connect_info->{cursor_class} = $cursor_class;
- }
-
- $self->caching(1);
-
- 1;
-}
-
sub _reset_cursor_class {
my $self = shift;
- if ($self->connect_info->{cursor_class} eq 'DBIx::Class::Cursor::Cached') {
- $self->storage->cursor_class('DBIx::Class::Storage::DBI::Cursor');
+ if ($self->storage->can('cursor_class')) {
+ $self->storage->cursor_class($self->_default_cursor_class)
+ if $self->storage->cursor_class ne $self->_default_cursor_class;
}
-
- 1;
}
-=back
+__PACKAGE__->meta->make_immutable;
=head1 SEE ALSO
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<DBIx::Class::Schema::Loader>, L<Catalyst::Helper::Model::DBIC::Schema>,
+L<MooseX::Object::Pluggable>
+
+Roles:
+
+L<Catalyst::Model::DBIC::Schema::Role::Caching>,
+L<Catalyst::Model::DBIC::Schema::Role::Replicated>
=head1 AUTHOR
Brandon L Black, C<blblack@gmail.com>
+Contributors:
+
+Rafael Kitover, C<<rkitover at cpan.org>>
+
=head1 COPYRIGHT
This program is free software, you can redistribute it and/or modify it
projects / catagits/Catalyst-Model-DBIC-Schema.git / blobdiff