Bug 15632: Koha::Patron::Messages - Add new classes

The following 4 CRUD subroutines in C4::Members:
- AddMessage
- DeleteMessage
- GetMessagesCount
- GetMessages

could be replaced with a new package based on Koha::Objets.
This patchset will add the 2 Koha::Patron::Message[s] classes, then use
it to replace the different calls to these subroutine.
It will slightly reduce the size of C4::Members

Signed-off-by: Marc Véron <veron@veron.ch>
Signed-off-by: Brendan A Gallagher <brendan@bywatersolutions.com>

diff --git a/Koha/Patron/Message.pm b/Koha/Patron/Message.pm
new file mode 100644 (file)
index 0000000..dfe3d82
--- /dev/null
+++ b/Koha/Patron/Message.pm
@@ -0,0 +1,44 @@
+package Koha::Patron::Message;
+
+# This file is part of Koha.
+#
+# Koha is free software; you can redistribute it and/or modify it under the
+# terms of the GNU General Public License as published by the Free Software
+# Foundation; either version 3 of the License, or (at your option) any later
+# version.
+#
+# Koha is distributed in the hope that it will be useful, but WITHOUT ANY
+# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
+# A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along
+# with Koha; if not, write to the Free Software Foundation, Inc.,
+# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
+use Modern::Perl;
+
+use Carp;
+
+use Koha::Database;
+
+use base qw(Koha::Object);
+
+=head1 NAME
+
+Koha::Patron::Message - Koha Message Object class
+
+=head1 API
+
+=head2 Class Methods
+
+=cut
+
+=head3 type
+
+=cut
+
+sub type {
+    return 'Message';
+}
+
+1;

diff --git a/Koha/Patron/Messages.pm b/Koha/Patron/Messages.pm
new file mode 100644 (file)
index 0000000..4f2f9f4
--- /dev/null
+++ b/Koha/Patron/Messages.pm
@@ -0,0 +1,50 @@
+package Koha::Patron::Messages;
+
+# This file is part of Koha.
+#
+# Koha is free software; you can redistribute it and/or modify it under the
+# terms of the GNU General Public License as published by the Free Software
+# Foundation; either version 3 of the License, or (at your option) any later
+# version.
+#
+# Koha is distributed in the hope that it will be useful, but WITHOUT ANY
+# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
+# A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along
+# with Koha; if not, write to the Free Software Foundation, Inc.,
+# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
+use Modern::Perl;
+
+use Carp;
+
+use Koha::Database;
+
+use Koha::Patron::Message;
+
+use base qw(Koha::Objects);
+
+=head1 NAME
+
+Koha::Patron::Messages - Koha Message Object set class
+
+=head1 API
+
+=head2 Class Methods
+
+=cut
+
+=head3 type
+
+=cut
+
+sub type {
+    return 'Message';
+}
+
+sub object_class {
+    return 'Koha::Patron::Message';
+}
+
+1;

diff --git a/t/db_dependent/Koha/Patron/Messages.t b/t/db_dependent/Koha/Patron/Messages.t
new file mode 100644 (file)
index 0000000..9cab130
--- /dev/null
+++ b/t/db_dependent/Koha/Patron/Messages.t
@@ -0,0 +1,63 @@
+#!/usr/bin/perl
+
+# Copyright 2015 Koha Development team
+#
+# This file is part of Koha
+#
+# Koha is free software; you can redistribute it and/or modify it
+# under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 3 of the License, or
+# (at your option) any later version.
+#
+# Koha is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Koha; if not, see <http://www.gnu.org/licenses>.
+
+use Modern::Perl;
+
+use Test::More tests => 4;
+
+use Koha::Patron::Message;
+use Koha::Patron::Messages;
+use Koha::Database;
+
+use t::lib::TestBuilder;
+
+my $schema = Koha::Database->new->schema;
+$schema->storage->txn_begin;
+
+my $builder        = t::lib::TestBuilder->new;
+my $library        = $builder->build( { source => 'Branch' } );
+my $patron         = $builder->build( { source => 'Borrower', values => { branchcode => $library->{branchcode} } } );
+my $nb_of_messages = Koha::Patron::Messages->search->count;
+my $new_message_1  = Koha::Patron::Message->new(
+    {   borrowernumber => $patron->{borrowernumber},
+        branchcode     => $library->{branchcode},
+        message_type   => 'L',
+        message        => 'my message 1',
+    }
+)->store;
+my $new_message_2  = Koha::Patron::Message->new(
+    {   borrowernumber => $patron->{borrowernumber},
+        branchcode     => $library->{branchcode},
+        message_type   => 'B',
+        message        => 'my message 2',
+    }
+)->store;
+
+like( $new_message_1->message_id, qr|^\d+$|, 'Adding a new message should have set the message_id');
+is( Koha::Patron::Messages->search->count, $nb_of_messages + 2, 'The 2 messages should have been added' );
+
+my $retrieved_message_1 = Koha::Patron::Messages->find( $new_message_1->message_id );
+is( $retrieved_message_1->message, $new_message_1->message, 'Find a message by id should return the correct message' );
+
+$retrieved_message_1->delete;
+is( Koha::Patron::Messages->search->count, $nb_of_messages + 1, 'Delete should have deleted the message' );
+
+$schema->storage->txn_rollback;
+
+1;