ActiveRecord-Simple
view release on metacpan or search on metacpan
lib/ActiveRecord/Simple.pm view on Meta::CPAN
package ActiveRecord::Simple;
use 5.010;
use strict;
use warnings;
our $VERSION = '1.11';
use utf8;
use Carp;
use Scalar::Util qw/blessed/;
use ActiveRecord::Simple::QueryManager;
use ActiveRecord::Simple::Utils qw/all_blessed class_to_table_name load_module/;
use ActiveRecord::Simple::Connect;
our $connector;
my $qm = ActiveRecord::Simple::QueryManager->new();
sub new {
my $class = shift;
my $params = (scalar @_ > 1) ? {@_} : $_[0];
# relations
$class->_init_relations if $class->can('_get_relations');
return bless $params || {}, $class;
}
sub auto_load {
my ($class) = @_;
my $table_name = class_to_table_name($class);
# 0. check the name
my $table_info_sth = $class->dbh->table_info('', '%', $table_name, 'TABLE');
$table_info_sth->fetchrow_hashref or croak "Can't find table '$table_name' in the database";
# 1. columns list
my $column_info_sth = $class->dbh->column_info(undef, undef, $table_name, undef);
my $cols = $column_info_sth->fetchall_arrayref({});
my @columns = ();
push @columns, $_->{COLUMN_NAME} for @$cols;
# 2. Primary key
my $primary_key_sth = $class->dbh->primary_key_info(undef, undef, $table_name);
my $primary_key_data = $primary_key_sth->fetchrow_hashref;
my $primary_key = ($primary_key_data) ? $primary_key_data->{COLUMN_NAME} : undef;
$class->table_name($table_name) if $table_name;
$class->primary_key($primary_key) if $primary_key;
$class->columns(@columns) if @columns;
}
sub connect {
my ($class, $dsn, $username, $password, $options) = @_;
eval { require DBIx::Connector };
$options->{HandleError} = sub {
my ($error_message, $DBI_st) = @_;
$error_message or return;
croak $error_message;
} if ! exists $options->{HandleError};
if ($@) {
$connector = ActiveRecord::Simple::Connect->new($dsn, $username, $password, $options);
$connector->db_connect;
}
else {
$connector = DBIx::Connector->new($dsn, $username, $password, $options);
}
return 1;
}
sub belongs_to {
my ($class, $rel_name, $rel_class, $params) = @_;
my $new_relation = {
class => $rel_class,
type => 'one',
};
lib/ActiveRecord/Simple.pm view on Meta::CPAN
#### Find ####
sub find {
$qm->{caller} = shift;
carp
q/[DEPRECATED] This method is DEPRECATED since version 1.10. '/ .
q/Please, use "find" via "objects" method: / . $qm->{caller} . q/->objects->find/;
$qm->find(@_);
}
sub all {
$qm->{caller} = shift;
carp
q/[DEPRECATED] This method is DEPRECATED since version 1.10. '/ .
q/Please, use "all" via "objects" method: / . $qm->{caller} . q/->objects->all/;
$qm->all();
}
sub get {
$qm->{caller} = shift;
carp
q/[DEPRECATED] This method is DEPRECATED since version 1.10. '/ .
q/Please, use "get" via "objects" method: / . $qm->{caller} . q/->objects->get/;
$qm->get(@_);
}
sub exists {
my $first_arg = shift;
my ($class, @search_criteria);
if (ref $first_arg) {
# FIXME: Ugly solution, need some beautifulness =)
# object method
$class = ref $first_arg;
if ($class eq 'ActiveRecord::Simple::Find') {
return $first_arg->exists;
}
else {
return ActiveRecord::Simple::Find->new($class, $first_arg->to_hash({ only_defined_fields => 1 }))->exists;
}
}
else {
carp '[DEPRECATED] This way of using method "exists" is deprecated. Please, see documentation to know how does it work now.';
$class = $first_arg;
@search_criteria = @_;
return (defined $class->find(@search_criteria)->fetch) ? 1 : 0;
}
}
sub _find_many_to_many { ActiveRecord::Simple::Find->_find_many_to_many(shift, @_) }
sub DESTROY {}
### Private
sub _get_primary_key_value {
my ($self) = @_;
croak "Sory, you can call method '_get_primary_key_value' on unblessed scalar."
unless blessed $self;
my $pk = $self->_get_primary_key;
return $self->$pk;
}
sub _get_relation_type {
my ($class, $relation) = @_;
my $type = $relation->{type};
$type .= '_to_';
my $related_class = _get_related_class($relation);
#eval { load $related_class }; ### TODO: check module is loaded
#load $related_class;
#load $related_class unless is_loaded $related_class;
#mark_as_loaded $related_class;
load_module $related_class;
my $rel_type = undef;
while (my ($rel_key, $rel_opts) = each %{ $related_class->_get_relations }) {
next if $class ne _get_related_class($rel_opts);
$rel_type = $rel_opts->{type};
}
croak 'Oops! Looks like related class ' . $related_class . ' has no relations with ' . $class unless $rel_type;
$type .= $rel_type;
return $type;
}
sub _get_related_subclass {
my ($relation) = @_;
return undef if !ref $relation->{class};
my $subclass;
if (ref $relation->{class} eq 'HASH') {
$subclass = (keys %{ $relation->{class} })[0];
}
elsif (ref $relation->{class} eq 'ARRAY') {
$subclass = $relation->{class}[0];
}
return $subclass;
}
sub _get_related_class {
my ($relation) = @_;
return $relation->{class} if !ref $relation->{class};
my $related_class;
if (ref $relation->{class} eq 'HASH') {
$related_class = ( %{ $relation->{class} } )[1]
}
elsif (ref $relation->{class} eq 'ARRAY') {
lib/ActiveRecord/Simple.pm view on Meta::CPAN
$table_name =~ s/s$// if $what_key eq 'foreign_key';
return ($what_key eq 'foreign_key') ? "$table_name\_id" : undef;
}
sub _delete_keys {
my ($self, $rx) = @_;
map { delete $self->{$_} if $_ =~ $rx } keys %$self;
}
sub _append_relation {
my ($class, $rel_name, $rel_hashref) = @_;
if ($class->can('_get_relations')) {
my $relations = $class->_get_relations();
$relations->{$rel_name} = $rel_hashref;
$class->relations($relations);
}
else {
$class->relations({ $rel_name => $rel_hashref });
}
return $rel_hashref;
}
sub _mk_attribute_getter {
my ($class, $method_name, $return) = @_;
return if $class->can($method_name);
eval "package $class; \n sub $method_name { \$return }";
}
sub _init_relations {
my ($class) = @_;
my $relations = $class->_get_relations;
no strict 'refs';
RELATION_NAME:
for my $relation_name ( keys %{ $relations }) {
my $pkg_method_name = $class . '::' . $relation_name;
next RELATION_NAME if $class->can($pkg_method_name); ### FIXME: orrrr $relation_name???
my $relation = $relations->{$relation_name};
my $full_relation_type = _get_relation_type($class, $relation);
my $related_class = _get_related_class($relation);
### TODO: check for error if returns undef
my $pk = $relation->{params}{pk};
my $fk = $relation->{params}{fk};
my $instance_name = "relation_instance_$relation_name";
if (grep { $full_relation_type eq $_ } qw/one_to_many one_to_one one_to_only/) {
*{$pkg_method_name} = sub {
my ($self, @args) = @_;
if (@args) {
my $object = shift @args;
croak "Using unblessed scalar as an object reference"
unless blessed $object;
$object->save() if ! exists $object->{isin_database} && !$object->{isin_database} == 1;
#$self->$fk($object->$pk);
$self->{$fk} = $object->{$pk};
$self->{$instance_name} = $object;
return $self;
}
# else
if (!$self->{$instance_name}) {
$self->{$instance_name} = $related_class->objects->get($self->{$fk}) // $related_class;
}
return $self->{$instance_name};
}
}
elsif ($full_relation_type eq 'only_to_one') {
*{$pkg_method_name} = sub {
my ($self, @args) = @_;
if (!$self->{$instance_name}) {
$self->{$instance_name} = $related_class->find("$fk = ?", $self->{$pk})->fetch;
}
return $self->{$instance_name};
}
}
elsif ($full_relation_type eq 'many_to_one') {
*{$pkg_method_name} = sub {
my ($self, @args) = @_;
if (@args) {
unless (all_blessed(\@args)) {
return $related_class->find(@args)->left_join($self->_get_table_name);
}
OBJECT:
for my $object (@args) {
next OBJECT if !blessed $object;
my $pk = $self->_get_primary_key;
#$object->$fk($self->$pk)->save;
$object->{$fk} = $self->{$pk};
$object->save();
}
return $self;
}
# else
return $related_class->new() if not $self->can('_get_primary_key');
if (!$self->{$instance_name}) {
$self->{$instance_name} = $related_class->objects->find("$fk = ?", $self->{$pk});
}
return $self->{$instance_name};
}
}
elsif ($full_relation_type eq 'many_to_many') {
*{$pkg_method_name} = sub {
my ($self, @args) = @_;
if (@args) {
my $related_subclass = _get_related_subclass($relation);
unless (all_blessed(\@args)) {
return $related_class->_find_many_to_many({
root_class => $class,
via_table => $relation->{via_table},
m_class => $related_subclass,
self => $self,
where_statement => \@args,
});
}
if (defined $related_subclass) {
my ($fk1, $fk2);
$fk1 = $fk;
RELATED_CLASS_RELATION:
for my $related_class_relation (values %{ $related_class->_get_relations }) {
next RELATED_CLASS_RELATION
unless _get_related_subclass($related_class_relation)
&& $related_subclass eq _get_related_subclass($related_class_relation);
$fk2 = $related_class_relation->{params}{fk};
}
my $pk1_name = $self->_get_primary_key;
my $pk1 = $self->{$pk1_name};
defined $pk1 or croak 'You are trying to create relations between unsaved objects. Save your ' . $class . ' object first';
OBJECT:
for my $object (@args) {
next OBJECT if !blessed $object;
my $pk2_name = $object->_get_primary_key;
my $pk2 = $object->{$pk2_name};
$related_subclass->new($fk1 => $pk1, $fk2 => $pk2)->save;
}
}
else {
my ($fk1, $fk2);
$fk1 = $fk;
$fk2 = class_to_table_name($related_class) . '_id';
my $pk1_name = $self->_get_primary_key;
my $pk1 = $self->{$pk1_name};
my $via_table = $relation->{via_table};
OBJECT:
for my $object (@args) {
next OBJECT if !blessed $object;
my $pk2_name = $object->_get_primary_key;
my $pk2 = $object->{$pk2_name};
my $sql = qq/INSERT INTO "$via_table" ("$fk1", "$fk2") VALUES (?, ?)/;
$self->dbh->do($sql, undef, $pk1, $pk2);
}
}
return $self;
}
# else
if (!$self->{$instance_name}) {
$self->{$instance_name} = $related_class->_find_many_to_many({
root_class => $class,
m_class => _get_related_subclass($relation),
via_table => $relation->{via_table},
self => $self,
});
}
return $self->{$instance_name};
}
}
elsif ($full_relation_type eq 'generic_to_generic') {
*{$pkg_method_name} = sub {
my ($self, @args) = @_;
if (!$self->{$instance_name}) {
my %find_attrs;
while (my ($k, $v) = each %{ $relation->{key} }) {
$find_attrs{$v} = $self->{$k};
}
$self->{$instance_name} = $related_class->find(\%find_attrs);
}
return $self->{$instance_name};
}
}
}
use strict 'refs';
}
sub _what_is_the_table_name {
my $class = ref $_[0] ? ref $_[0] : $_[0];
croak 'Invalid data class' if $class =~ /^ActiveRecord::Simple/;
my $table_name =
$class->can('_get_table_name') ?
$class->_get_table_name
: class_to_table_name($class);
return $table_name;
}
1;
lib/ActiveRecord/Simple.pm view on Meta::CPAN
my $finder = Customer->find(); # it's like ActiveRecord::Simple::Find->new();
$finder->order_by('id');
my @customers = $finder->fetch;
=head2 all [DEPRECATED]
Same as __PACKAGE__->find->fetch;
=head2 get [DEPRECATED]
Get object by primary_key
my $customer = Customer->get(1);
# same as Customer->find({ id => 1 })->fetch;
=head2 count
Get number of rows
my $cnt = Customer->count('age > ?', 21);
=head2 exists
Check if row is exists in the database
warn "Got Barak!"
if Customer->exists({ name => 'Barak Obama' })
=head1 OBJECT METHODS
L<ActiveRecord::Simple> implements the following object methods.
=head2 is_defined
Check object is defined
=head2 save
Save object to the database
=head2 delete
Delete object from the database
=head2 update
Update object using hashref
$user->update({ last_login => \'NOW()' });
=head2 to_hash
Unbless object, get naked hash
=head2 increment
Increment fields
$customer->increment('age')->save;
=head2 decrement
Decrement fields
$customer->decrement('age')->save;
=head1 AUTHOR
shootnix, C<< <shootnix at cpan.org> >>
=head1 BUGS
Please report any bugs or feature requests to C<shootnix@cpan.org>, or through
the github: https://github.com/shootnix/activerecord-simple/issues
=head1 SUPPORT
You can find documentation for this module with the perldoc command.
perldoc ActiveRecord::Simple
You can also look for information at:
=over 1
=item * Github wiki:
L<https://github.com/shootnix/activerecord-simple/wiki>
=back
=head1 ACKNOWLEDGEMENTS
=head1 LICENSE AND COPYRIGHT
Copyright 2013-2018 shootnix.
This program is free software; you can redistribute it and/or modify it
under the terms of either: the GNU General Public License as published
by the Free Software Foundation; or the Artistic License.
See http://dev.perl.org/licenses/ for more information.
=cut
( run in 0.721 second using v1.01-cache-2.11-cpan-39bf76dae61 )