Attachment 135602 Details for Bug 24857 – Bug 24857: Add Koha Objects

[patch] Bug 24857: Add Koha Objects

Bug-24857-Add-Koha-Objects.patch (text/plain), 9.93 KB, created by Kyle M Hall (khall) on 2022-06-02 16:28:17 UTC

(hide)

Description:

Filename:

MIME Type:

Creator: Kyle M Hall (khall)

Created: 2022-06-02 16:28:17 UTC

Size: 9.93 KB

patch

obsolete

>From b78ae054e9604d74cdceb60ff786434772c2da6c Mon Sep 17 00:00:00 2001
>From: Nick Clemens <nick@bywatersolutions.com>
>Date: Tue, 8 Mar 2022 11:27:59 +0000
>Subject: [PATCH] Bug 24857: Add Koha Objects
>
>To test:
>1 - prove t/db_dependent/Koha/Biblio/ItemGroups.t
>---
> Koha/Biblio/ItemGroup.pm                | 142 ++++++++++++++++++++++++
> Koha/Biblio/ItemGroup/Item.pm           |  46 ++++++++
> Koha/Biblio/ItemGroup/Items.pm          |  48 ++++++++
> Koha/Biblio/ItemGroups.pm               |  48 ++++++++
> t/db_dependent/Koha/Biblio/ItemGroups.t |  70 ++++++++++++
> 5 files changed, 354 insertions(+)
> create mode 100644 Koha/Biblio/ItemGroup.pm
> create mode 100644 Koha/Biblio/ItemGroup/Item.pm
> create mode 100644 Koha/Biblio/ItemGroup/Items.pm
> create mode 100644 Koha/Biblio/ItemGroups.pm
> create mode 100755 t/db_dependent/Koha/Biblio/ItemGroups.t
>
>diff --git a/Koha/Biblio/ItemGroup.pm b/Koha/Biblio/ItemGroup.pm
>new file mode 100644
>index 0000000000..8c4ba66db1
>--- /dev/null
>+++ b/Koha/Biblio/ItemGroup.pm
>@@ -0,0 +1,142 @@
>+package Koha::Biblio::ItemGroup;
>+
>+# 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 base qw(Koha::Object);
>+
>+use Koha::Biblio::ItemGroup::Items;
>+use Koha::Exceptions::Object;
>+use Koha::Items;
>+
>+=head1 NAME
>+
>+Koha::Biblio::ItemGroup - Koha ItemGroup Object class
>+
>+=head1 API
>+
>+=head2 Class methods
>+
>+=head3 store
>+
>+    $item_group->store;
>+
>+Overloaded I<store> method that takes care of creation date handling.
>+
>+=cut
>+
>+sub store {
>+    my ($self) = @_;
>+
>+    unless ( $self->in_storage ) {
>+        # new entry
>+        $self->set(
>+            {
>+                created_on => \'NOW()'
>+            }
>+        );
>+    }
>+
>+    return $self->SUPER::store();
>+}
>+
>+=head3 items
>+
>+    my $items = $item_group->items;
>+
>+Returns all the items linked to the item group.
>+
>+=cut
>+
>+sub items {
>+    my ($self) = @_;
>+
>+    my $items_rs = $self->_result->item_group_items;
>+    my @item_ids = $items_rs->get_column('item_id')->all;
>+
>+    return Koha::Items->new->empty unless @item_ids;
>+
>+    return Koha::Items->search(
>+        {
>+            itemnumber => {
>+                -in => \@item_ids
>+            }
>+        }
>+    );
>+}
>+
>+=head3 add_item
>+
>+    $item_group->add_item({ item_id => $item_id });
>+
>+=cut
>+
>+sub add_item {
>+    my ($self, $params) = @_;
>+
>+    my $item_id = $params->{item_id};
>+
>+    my $item = Koha::Items->find( $item_id );
>+    unless ( $item->biblionumber == $self->biblio_id ) {
>+        Koha::Exceptions::Object::FKConstraint->throw(
>+            broken_fk => 'biblio_id'
>+        );
>+    }
>+
>+    Koha::Biblio::ItemGroup::Item->new(
>+        {
>+            item_group_id => $self->id,
>+            item_id       => $item_id,
>+        }
>+    )->store;
>+
>+    return $self;
>+}
>+
>+=head3 to_api_mapping
>+
>+This method returns the mapping for representing a Koha::Biblio::ItemGroup object
>+on the API.
>+
>+=cut
>+
>+sub to_api_mapping {
>+    return {
>+        created_on   => 'creation_date',
>+        updated_on   => 'modification_date'
>+    };
>+}
>+
>+=head2 Internal methods
>+
>+=head3 _type
>+
>+=cut
>+
>+sub _type {
>+    return 'ItemGroup';
>+}
>+
>+=head3 object_class
>+
>+=cut
>+
>+sub object_class {
>+    return 'Koha::Biblio::ItemGroup';
>+}
>+
>+1;
>diff --git a/Koha/Biblio/ItemGroup/Item.pm b/Koha/Biblio/ItemGroup/Item.pm
>new file mode 100644
>index 0000000000..17a175f302
>--- /dev/null
>+++ b/Koha/Biblio/ItemGroup/Item.pm
>@@ -0,0 +1,46 @@
>+package Koha::Biblio::ItemGroup::Item;
>+
>+# 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 base qw(Koha::Object);
>+
>+=head1 NAME
>+
>+Koha::Biblio::ItemGroup::Item - Koha ItemGroup Item Object class
>+
>+=head1 API
>+
>+=head2 Internal methods
>+
>+=head3 _type
>+
>+=cut
>+
>+sub _type {
>+    return 'ItemGroupItem';
>+}
>+
>+=head3 object_class
>+
>+=cut
>+
>+sub object_class {
>+    return 'Koha::Biblio::ItemGroup::Item';
>+}
>+
>+1;
>diff --git a/Koha/Biblio/ItemGroup/Items.pm b/Koha/Biblio/ItemGroup/Items.pm
>new file mode 100644
>index 0000000000..9018c5e5fa
>--- /dev/null
>+++ b/Koha/Biblio/ItemGroup/Items.pm
>@@ -0,0 +1,48 @@
>+package Koha::Biblio::ItemGroup::Items;
>+
>+# 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 Koha::Biblio::ItemGroup::Item;
>+
>+use base qw(Koha::Objects);
>+
>+=head1 NAME
>+
>+Koha::Biblio::ItemGroup::Items - Koha ItemGroup Items Object set class
>+
>+=head1 API
>+
>+=head2 Internal methods
>+
>+=head3 _type
>+
>+=cut
>+
>+sub _type {
>+    return 'ItemGroupItem';
>+}
>+
>+=head3 object_class
>+
>+=cut
>+
>+sub object_class {
>+    return 'Koha::Biblio::ItemGroup::Item';
>+}
>+
>+1;
>diff --git a/Koha/Biblio/ItemGroups.pm b/Koha/Biblio/ItemGroups.pm
>new file mode 100644
>index 0000000000..78a6b337c6
>--- /dev/null
>+++ b/Koha/Biblio/ItemGroups.pm
>@@ -0,0 +1,48 @@
>+package Koha::Biblio::ItemGroups;
>+
>+# 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 Koha::Biblio::ItemGroup;
>+
>+use base qw(Koha::Objects);
>+
>+=head1 NAME
>+
>+Koha::Biblio::ItemGroups - Koha ItemGroup Object set class
>+
>+=head1 API
>+
>+=head2 Internal methods
>+
>+=head3 _type
>+
>+=cut
>+
>+sub _type {
>+    return 'ItemGroup';
>+}
>+
>+=head3 object_class
>+
>+=cut
>+
>+sub object_class {
>+    return 'Koha::Biblio::ItemGroup';
>+}
>+
>+1;
>diff --git a/t/db_dependent/Koha/Biblio/ItemGroups.t b/t/db_dependent/Koha/Biblio/ItemGroups.t
>new file mode 100755
>index 0000000000..321e778842
>--- /dev/null
>+++ b/t/db_dependent/Koha/Biblio/ItemGroups.t
>@@ -0,0 +1,70 @@
>+#!/usr/bin/perl
>+
>+# 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 => 3;
>+
>+use Koha::Database;
>+
>+use t::lib::TestBuilder;
>+use t::lib::Mocks;
>+
>+BEGIN {
>+    use_ok('Koha::Biblio::ItemGroup');
>+    use_ok('Koha::Biblio::ItemGroups');
>+}
>+
>+my $schema  = Koha::Database->new->schema;
>+my $builder = t::lib::TestBuilder->new;
>+
>+t::lib::Mocks::mock_preference('EnableItemGroups', 1);
>+
>+subtest 'add_item() and items() tests' => sub {
>+
>+    plan tests => 8;
>+
>+    $schema->storage->txn_begin;
>+
>+    my $biblio = $builder->build_sample_biblio();
>+    my $item_1 = $builder->build_sample_item({ biblionumber => $biblio->biblionumber });
>+    my $item_2 = $builder->build_sample_item({ biblionumber => $biblio->biblionumber });
>+
>+    my $item_group = Koha::Biblio::ItemGroup->new( { biblio_id => $biblio->id } )->store();
>+
>+    my $items = $item_group->items;
>+    is( $items->count, 0, 'Item group has no items');
>+
>+    $item_group->add_item({ item_id => $item_1->id });
>+    my @items = $item_group->items->as_list();
>+    is( scalar(@items), 1, 'Item group has one item');
>+    is( $items[0]->id, $item_1->id, 'Item 1 is correct' );
>+
>+    $item_group->add_item({ item_id => $item_2->id });
>+    @items = $item_group->items->as_list();
>+    is( scalar(@items), 2, 'Item group has two items');
>+    is( $items[0]->id, $item_1->id, 'Item 1 is correct' );
>+    is( $items[1]->id, $item_2->id, 'Item 2 is correct' );
>+
>+    # Remove an item
>+    $item_1->delete;
>+    @items = $item_group->items->as_list();
>+    is( scalar(@items), 1, 'Item group now has only one item');
>+    is( $items[0]->id, $item_2->id, 'Item 2 is correct' );
>+
>+    $schema->storage->txn_rollback;
>+};
>-- 
>2.30.2

Actions: View | Diff | Splinter Review

Attachments on bug 24857: 100652 | 100653 | 100654 | 100655 | 100656 | 100657 | 100658 | 100659 | 100660 | 100661 | 100662 | 101637 | 101638 | 101639 | 101640 | 101641 | 101642 | 101643 | 101644 | 101645 | 101646 | 101647 | 101648 | 101650 | 101651 | 101652 | 101653 | 101654 | 101655 | 101656 | 101657 | 101658 | 101659 | 101660 | 101661 | 101670 | 101671 | 101672 | 101673 | 101674 | 101675 | 101676 | 101677 | 101678 | 101679 | 101680 | 101681 | 101730 | 101731 | 101732 | 101733 | 101734 | 101735 | 101736 | 101737 | 101738 | 101739 | 101740 | 101741 | 101752 | 101753 | 101754 | 101755 | 101756 | 101757 | 101758 | 101759 | 101760 | 101761 | 101762 | 101763 | 104952 | 104953 | 104954 | 104955 | 104956 | 104957 | 104958 | 104959 | 104960 | 104961 | 104962 | 104963 | 104964 | 104966 | 106728 | 106729 | 106730 | 106731 | 106732 | 106733 | 106734 | 106735 | 106736 | 106737 | 106738 | 106739 | 106740 | 106741 | 108443 | 108444 | 108445 | 108446 | 108447 | 108448 | 108449 | 108450 | 108451 | 108452 | 108453 | 108454 | 108455 | 108456 | 108666 | 108667 | 108668 | 108669 | 108670 | 108671 | 108672 | 108673 | 108674 | 108675 | 108676 | 108677 | 108678 | 108679 | 108680 | 108681 | 108682 | 108683 | 108684 | 108685 | 108686 | 109074 | 109075 | 109076 | 109077 | 109078 | 109079 | 109080 | 109081 | 109082 | 109083 | 109084 | 109085 | 109086 | 109087 | 109088 | 109089 | 109090 | 109091 | 109092 | 109093 | 109094 | 109795 | 109796 | 109797 | 109798 | 109799 | 109800 | 109801 | 109802 | 109803 | 109804 | 109805 | 109806 | 109807 | 109808 | 109809 | 109810 | 109811 | 109812 | 109813 | 109814 | 109815 | 109894 | 109901 | 109902 | 109903 | 109904 | 109905 | 109906 | 109907 | 109908 | 109909 | 109910 | 109911 | 109912 | 109913 | 109914 | 109915 | 109916 | 109917 | 109918 | 109919 | 109920 | 109921 | 109922 | 109923 | 113136 | 113137 | 113138 | 113139 | 113140 | 113141 | 113142 | 113143 | 113144 | 113145 | 113146 | 113147 | 113148 | 113149 | 113150 | 113151 | 113152 | 113153 | 113154 | 113155 | 113156 | 113157 | 113158 | 113159 | 113160 | 113168 | 113169 | 113170 | 113171 | 113172 | 113173 | 113174 | 113175 | 113176 | 113177 | 113178 | 113179 | 113180 | 113181 | 113182 | 113183 | 113184 | 113185 | 113186 | 113187 | 113188 | 113189 | 113190 | 113191 | 120495 | 120496 | 120497 | 120498 | 120499 | 120500 | 120501 | 120502 | 120503 | 120504 | 120505 | 120506 | 120507 | 120508 | 120509 | 120510 | 120511 | 120512 | 120513 | 120514 | 120515 | 120516 | 120517 | 120518 | 122808 | 122809 | 122810 | 122811 | 122812 | 122813 | 122814 | 122815 | 122816 | 122817 | 122818 | 122819 | 122820 | 122821 | 122822 | 122823 | 122824 | 122825 | 122826 | 122827 | 122828 | 122829 | 122830 | 122831 | 123882 | 123883 | 123884 | 123885 | 123886 | 123887 | 123888 | 123889 | 123890 | 123891 | 123892 | 123893 | 123894 | 123895 | 123896 | 123897 | 123898 | 123899 | 123900 | 123901 | 123902 | 123903 | 123904 | 123905 | 123906 | 123907 | 123908 | 123909 | 123910 | 123912 | 124021 | 124022 | 124023 | 124024 | 124025 | 124026 | 124027 | 124028 | 124029 | 124030 | 124031 | 124032 | 124033 | 124034 | 124035 | 124036 | 124037 | 124038 | 124039 | 124040 | 124041 | 124042 | 124043 | 124044 | 124045 | 124046 | 124047 | 124048 | 124049 | 124050 | 124051 | 124052 | 124053 | 124331 | 124332 | 124333 | 124334 | 124335 | 124336 | 124337 | 124338 | 124339 | 124340 | 124341 | 124342 | 124343 | 124344 | 124345 | 124346 | 124347 | 124348 | 124349 | 124351 | 124352 | 124353 | 124354 | 124355 | 124356 | 124357 | 124358 | 124359 | 124360 | 124361 | 124362 | 124363 | 124421 | 124463 | 124583 | 124584 | 124585 | 124586 | 124587 | 124588 | 124589 | 124590 | 124591 | 124592 | 124593 | 124594 | 124595 | 124596 | 124597 | 124598 | 124599 | 124600 | 124601 | 124602 | 124603 | 124604 | 124605 | 124606 | 124607 | 124608 | 124609 | 124610 | 124611 | 124612 | 124613 | 124614 | 124615 | 131449 | 131450 | 131451 | 131452 | 131453 | 131454 | 131455 | 131456 | 134288 | 134289 | 134290 | 134291 | 134292 | 134293 | 134294 | 134295 | 134296 | 135590 | 135591 | 135592 | 135593 | 135594 | 135595 | 135596 | 135597 | 135598 | 135599 | 135600 | 135601 | 135602 | 135603 | 135604 | 135605 | 135606 | 135607 | 135608 | 135609 | 135610 | 135614 | 135615 | 135616 | 135617 | 135618 | 135619 | 135620 | 135621 | 135622 | 135623 | 135624 | 135625 | 135626 | 135627 | 135628 | 135629 | 137259 | 137260 | 137261 | 137262 | 137263 | 137264 | 137265 | 137266 | 137267 | 137268 | 137311 | 137314 | 137315 | 137316 | 137317 | 137318 | 137319 | 137320 | 137321 | 137322 | 137323 | 137441 | 137442 | 137443 | 137608 | 138933