File Coverage

blib/lib/Mojolicious/Plugin/DBIC.pm

Criterion	Covered	Total	%
statement	27	27	100.0
branch	10	10	100.0
condition	4	6	66.6
subroutine	6	6	100.0
pod	1	1	100.0
total	48	50	96.0

package Mojolicious::Plugin::DBIC;
our $VERSION = '0.003';
# ABSTRACT: Mojolicious ♥ DBIx::Class

#pod =head1 SYNOPSIS
#pod
#pod     use Mojolicious::Lite;
#pod     plugin DBIC => {
#pod         schema => { 'Local::Schema' => 'dbi:SQLite::memory:' },
#pod     };
#pod     get '/model', {
#pod         controller => 'DBIC',
#pod         action => 'list',
#pod         resultset => 'Model',
#pod         template => 'model/list.html.ep',
#pod     };
#pod     app->start;
#pod     __DATA__
#pod     @@ model/list.html.ep
#pod     % for my $row ( $resultset->all ) {
#pod         <%= $row->id %>
#pod     % }
#pod
#pod =head1 DESCRIPTION
#pod
#pod This plugin makes working with L easier in Mojolicious.
#pod
#pod =head2 Configuration
#pod
#pod Configure your schema in multiple ways:
#pod
#pod     # Just DSN
#pod     plugin DBIC => {
#pod         schema => {
#pod             'MySchema' => 'DSN',
#pod         },
#pod     };
#pod
#pod     # Arguments to connect()
#pod     plugin DBIC => {
#pod         schema => {
#pod             'MySchema' => [ 'DSN', 'user', 'password', { RaiseError => 1 } ],
#pod         },
#pod     };
#pod
#pod     # Connected schema object
#pod     my $schema = MySchema->connect( ... );
#pod     plugin DBIC => {
#pod         schema => $schema,
#pod     };
#pod
#pod This plugin can also be configured from the application configuration
#pod file:
#pod
#pod     # myapp.conf
#pod     {
#pod         dbic => {
#pod             schema => {
#pod                 'MySchema' => 'dbi:SQLite:data.db',
#pod             },
#pod         },
#pod     }
#pod
#pod     # myapp.pl
#pod     use Mojolicious::Lite;
#pod     plugin 'Config';
#pod     plugin 'DBIC';
#pod
#pod =head2 Controller
#pod
#pod This plugin contains a controller to reduce the code needed for simple
#pod database operations. See L.
#pod
#pod =head1 SEE ALSO
#pod
#pod L, L, L
#pod
#pod =cut

use Mojo::Base 'Mojolicious::Plugin';
use Mojo::Loader qw( load_class );
use Scalar::Util qw( blessed );

sub register {
    my ( $self, $app, $conf ) = @_;
    # XXX Allow multiple schemas?
    my $schema_conf = $conf->{schema};
    if ( !$schema_conf && $app->can( 'config' ) ) {
        $schema_conf = $app->config->{dbic}{schema};
    }
    $app->helper( schema => sub {
        state $schema = _load_schema( $schema_conf );
        return $schema;
    } );
    push @{ $app->routes->namespaces }, 'Mojolicious::Plugin::DBIC::Controller';
}

sub _load_schema {
    my ( $conf ) = @_;
    if ( blessed $conf && $conf->isa( 'DBIx::Class::Schema' ) ) {
        return $conf;
    }
    elsif ( ref $conf eq 'HASH' ) {
        my ( $class, $args ) = %{ $conf };
        if ( my $e = load_class( $class ) ) {
            die sprintf 'Unable to load schema class %s: %s',
                $class, $e;
        }
        return $class->connect( ref $args eq 'ARRAY' ? @$args : $args );
    }
    die sprintf "Unknown DBIC schema config. Must be schema object or HASH, not %s",
        ref $conf;
}

1;

__END__