File Coverage

blib/lib/Mojolicious/Plugin/Model/DB.pm

Criterion	Covered	Total	%
statement	18	22	81.8
branch	4	8	50.0
condition	4	6	66.6
subroutine	4	4	100.0
pod			n/a
total	30	40	75.0

package Mojolicious::Plugin::Model::DB;
use Mojo::Base 'Mojolicious::Plugin::Model';
use Moo;

our $VERSION = '0.01';

after register => sub {
    my ($plugin, $app, $conf) = @_;

    $app->helper(
        db => sub {
            my ($self, $name) = @_;
            $name //= $conf->{default};

            my $model;
            return $model if $model = $plugin->{models}{$name};

            my $class = _load_class_for_name($plugin, $app, $conf, $name)
                or return undef;

            my $params = $conf->{params}{$name};
            $model = $class->new(ref $params eq 'HASH' ? %$params : (), app => $app);
            $plugin->{models}{$name} = $model;
            return $model;
        }
    );
};

sub _load_class_for_name {
    my ($plugin, $app, $conf, $name) = @_;
    return $plugin->{classes_loaded}{$name} if $plugin->{classes_loaded}{$name};

    my $namespace = $conf->{namespace}    // 'DB';
    my $ns        = $conf->{namespaces}   // [Mojolicious::Plugin::Model::camelize($app->moniker) . '::Model'];
    my $base      = $conf->{base_classes} // [qw(MojoX::Model)];

    $name = Mojolicious::Plugin::Model::camelize($name) if $name =~ /^[a-z]/;

    for my $class ( map "${_}::$namespace\::$name", @$ns ) {
        next unless Mojolicious::Plugin::Model::_load_class($class);

        unless ( Mojolicious::Plugin::Model::any { $class->isa($_) } @$base ) {
            $app->log->debug(qq[Class "$class" is not a model db]);
            next;
        }
        $plugin->{classes_loaded}{$name} = $class;
        return $class;
    }
    $app->log->debug(qq[Model db "$name" does not exist]);
    return undef;
}

1;

=encoding utf8

=head1 NAME

Mojolicious::Plugin::Model::DB - It is an extension of the module L for Mojolicious applications.

=head1 SYNOPSIS

Model DB Users

    package MyApp::Model::DB::Person;
    use Mojo::Base 'MojoX::Model';

    sub save {
        my ($self, $foo) = @_;

        $mysql->db->insert(
            'foo',
            {
                foo => $foo
            }
        );
    }

    1;

Mojolicious::Lite application

    #!/usr/bin/env perl
    use Mojolicious::Lite;

    use lib 'lib';

    plugin 'Model::DB';

    any '/' => sub {
        my $c = shift;

        my $foo = $c->param('foo') || '';

        # model db
        $c->db('person')->save($foo);

        $c->render(text => 'Save person foo');
    };

    app->start;

All available options

    #!/usr/bin/env perl
    use Mojolicious::Lite;

    plugin 'Model::DB' => {
        # Mojolicious::Plugin::Model::DB
        namespace => 'DataBase', # default is DB

        # Mojolicious::Plugin::Model
        namespaces   => ['MyApp::Model', 'MyApp::CLI::Model'],
        base_classes => ['MyApp::Model'],
        default      => 'MyApp::Model::Pg',
        params => {Pg => {uri => 'postgresql://user@/mydb'}}
    };

=head1 DESCRIPTION

Mojolicious::Plugin::Model::DB It is an extension of the module Mojolicious::Plugin::Model, the intention is to separate models of database from other models. See more in L

=head1 OPTIONS

=head2 namespace

    # Mojolicious::Lite
    plugin 'Model::DB' => {namespace => 'DataBase'}; # It's will load from $moniker::Model::DataBase

Namespace to load models from, defaults to C<$moniker::Model::DB>.

=head2 more options

see in L

=head1 HELPERS

L implements the following helpers.

=head2 db

    my $db = $c->db($name);

Load, create and cache a model object with given name. Default class for
model db C. Return `undef` if model db not found.

=head2 more helpers

see in L

=head1 SEE ALSO

L, L, L, L.

=head1 AUTHOR

Lucas Tiago de Moraes C

=head1 COPYRIGHT AND LICENSE

This software is copyright (c) 2019 by Lucas Tiago de Moraes.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

=cut