File Coverage

blib/lib/Mad/Mapper.pm

Criterion	Covered	Total	%
statement	66	214	30.8
branch	12	78	15.3
condition	3	45	6.6
subroutine	26	50	52.0
pod	5	6	83.3
total	112	393	28.5

package Mad::Mapper;

=encoding utf8

=head1 NAME

Mad::Mapper - Map Perl objects to PostgreSQL, MySQL or SQLite data

=head1 VERSION

0.07

=head1 DESCRIPTION

L is base class for objects that should be stored to the a
persistent SQL database. Currently the supported backends are L
L and L. These backends need to be installed
separately.

  $ cpanm Mad::Mapper
  $ cpanm Mojo::Pg # Mad::Mapper now support postgres!

THIS MODULE IS EXPERIMENTAL. It is in use in production though, so
big changes will not be made without extreme consideration.

=head1 SYNOPSIS

The synopsis is split into three parts: The two first is for model developers,
and the last is for the developer using the models.

  package MyApp::Model::User;
  use Mad::Mapper -base;

  # Class attributes
  col id => undef;
  col email => '';

See also L for more details and
L if you want more control.

=head1 RELATIONSHIPS

See L for example "has many" relationship.

TODO: C and maybe C.

=cut

use Mojo::Base -base;
use Mojo::IOLoop;
use Mojo::JSON ();
use Mojo::Loader 'load_class';
use Scalar::Util 'weaken';
use constant DEBUG => $ENV{MAD_DEBUG} || 0;

our $VERSION = '0.07';

my (%COLUMNS, %LOADED, %PK);

=head1 EXPORTED FUNCTIONS

=head2 col

Used to define a column. Follow the same rules as L.

=head2 has

  has name => "Bruce";
  has [qw(name email)];
  has pet => sub { Cat->new };

Same as L.

=head2 pk

Used to define a primary key. Follow the same rules as L.

The primary key is used by default in L and L to update the
correct row. If omitted, the first L will act as primary key.

Note that L is not returned by L.

=head2 table

Used to define a table name. The default is to decamelize the last part of the
class name and add "s" at the end, unless it already has "s" at the end.
Examples:

  .-------------------------------------.
  | Class name            | table       |
  |-----------------------|-------------|
  | App::Model::User      | users       |
  | App::Model::Users     | users       |
  | App::Model::Group     | groups      |
  | App::Model::UserAgent | user_agents |
  '-------------------------------------'

=head1 ATTRIBUTES

=head2 db

  $db = $self->db;
  $self->db($db_obj);

Need to hold either a L or L object.

=head2 in_storage

  $bool = $self->in_storage;
  $self = $self->in_storage($bool);

=cut

has db => sub { die "'db' is required in constructor." };
has in_storage => 0;

=head1 METHODS

=head2 expand_sst

  ($sst, @args) = $self->expand_sst($sst, @args);

Used to expand a given C<$sst> with variables defined by helpers.

=over 4

=item * %t

Will be replaced by