Bugzilla – Attachment 96615 Details for
Bug 24228
Add a parameter to recursively embed objects in Koha::Object(s)->to_api
Home
|
New
|
Browse
|
Search
|
[?]
|
Reports
|
Help
|
New Account
|
Log In
[x]
|
Forgot Password
Login:
[x]
[patch]
Bug 24228: Make ->to_api params a hashref
Bug-24228-Make--toapi-params-a-hashref.patch (text/plain), 9.66 KB, created by
Tomás Cohen Arazi (tcohen)
on 2019-12-23 17:49:59 UTC
(
hide
)
Description:
Bug 24228: Make ->to_api params a hashref
Filename:
MIME Type:
Creator:
Tomás Cohen Arazi (tcohen)
Created:
2019-12-23 17:49:59 UTC
Size:
9.66 KB
patch
obsolete
>From ca7277976a41d3366bbc018dab39b0e80ea9d66b Mon Sep 17 00:00:00 2001 >From: Tomas Cohen Arazi <tomascohen@theke.io> >Date: Mon, 23 Dec 2019 12:03:12 -0300 >Subject: [PATCH] Bug 24228: Make ->to_api params a hashref > >This patch makes the parameters for Koha::Object(s)->to_api a hashref >preparing the ground for new parameters. The proposed syntax is: > >$object->to_api( > { > embed => [ > { > accessor => 'items', > children => [ > ... > ] > } > ] > } >); > >Tests are added for the Koha::Objects implementation and tests for >Koha::Object are adjusted to the new syntax, and a test for the single >result accessor is added as well. > >To test: >1. Apply this patches >2. Run: > $ kshell > k$ prove t/db_dependent/Koha/Object.t t/db_dependent/Koha/Objects.t >=> SUCCESS: Tests pass! >3. Sign off :-D > >Signed-off-by: Tomas Cohen Arazi <tomascohen@theke.io> >--- > Koha/Object.pm | 34 ++++++++++++---- > Koha/Objects.pm | 4 +- > t/db_dependent/Koha/Object.t | 54 +++++++++++++++----------- > t/db_dependent/Koha/Objects.t | 73 ++++++++++++++++++++++++++++++++++- > 4 files changed, 132 insertions(+), 33 deletions(-) > >diff --git a/Koha/Object.pm b/Koha/Object.pm >index 553e53d28b..45933e9f0a 100644 >--- a/Koha/Object.pm >+++ b/Koha/Object.pm >@@ -373,16 +373,35 @@ sub _numeric_column_type { > > =head3 to_api > >- my $object_for_api = $object->to_api; >+ my $object_for_api = $object->to_api( >+ { >+ [ embed => [ >+ { >+ accessor => 'items', >+ children => [ >+ { >+ accessor => 'holds, >+ children => [ >+ ... >+ ] >+ } >+ ] >+ }, >+ ... >+ ] ] >+ } >+ ); > > Returns a representation of the object, suitable for API output. > > =cut > > sub to_api { >- my ( $self, $embeds ) = @_; >+ my ( $self, $params ) = @_; > my $json_object = $self->TO_JSON; > >+ my $embeds = $params->{embed}; >+ > # Rename attributes if there's a mapping > if ( $self->can('to_api_mapping') ) { > foreach my $column ( keys %{ $self->to_api_mapping } ) { >@@ -404,17 +423,18 @@ sub to_api { > > if ($embeds) { > foreach my $embed (@$embeds) { >- my ( $curr, $next ) = split /\s*\.\s*/, $embed, 2; >- my @nxembeds; >+ my $curr = $embed->{accessor}; >+ my $next = $embed->{children}; > >- @nxembeds = ($next) if $next; >+ my @nxembeds; >+ @nxembeds = @{ $next } if $next; > > my $children = $self->$curr; > if ( ref $children eq 'ARRAY' ) { > my @list; > my $pos = 0; > foreach my $child (@$children) { >- my $res = $child->to_api( \@nxembeds ); >+ my $res = $child->to_api({ embed => \@nxembeds }); > $res = { $json_object->{$curr}->[$pos], $res } > if defined $json_object->{$curr} > && defined $json_object->{$curr}->[$pos]; >@@ -424,7 +444,7 @@ sub to_api { > $json_object->{$curr} = \@list; > } > else { >- my $res = $children->to_api( \@nxembeds ); >+ my $res = $children->to_api({ embed => \@nxembeds }); > $res = { $json_object->{$curr}, $res } > if defined $json_object->{$curr}; > $json_object->{$curr} = $res; >diff --git a/Koha/Objects.pm b/Koha/Objects.pm >index 05b1de467d..82df97b687 100644 >--- a/Koha/Objects.pm >+++ b/Koha/Objects.pm >@@ -315,9 +315,9 @@ Returns a representation of the objects, suitable for API output . > =cut > > sub to_api { >- my ($self, $embeds) = @_; >+ my ($self, $params) = @_; > >- return [ map { $_->to_api($embeds) } $self->as_list ]; >+ return [ map { $_->to_api($params) } $self->as_list ]; > } > > =head3 Koha::Objects->_wrap >diff --git a/t/db_dependent/Koha/Object.t b/t/db_dependent/Koha/Object.t >index af97834a7d..f8eb73d4c1 100755 >--- a/t/db_dependent/Koha/Object.t >+++ b/t/db_dependent/Koha/Object.t >@@ -215,7 +215,7 @@ subtest 'TO_JSON tests' => sub { > > subtest "to_api() tests" => sub { > >- plan tests => 18; >+ plan tests => 20; > > $schema->storage->txn_begin; > >@@ -262,44 +262,52 @@ subtest "to_api() tests" => sub { > my $illrequest = $builder->build_object({ class => 'Koha::Illrequests' }); > is_deeply( $illrequest->to_api, $illrequest->TO_JSON, 'If no to_api_method present, return TO_JSON' ); > >- my $item_class = Test::MockModule->new('Koha::Item'); >- $item_class->mock( 'to_api_mapping', >- sub { >- return { >- itemnumber => 'item_id' >- }; >- } >- ); >- >- my $hold_class = Test::MockModule->new('Koha::Hold'); >- $hold_class->mock( 'to_api_mapping', >- sub { >- return { >- reserve_id => 'hold_id' >- }; >- } >- ); >- > my $biblio = $builder->build_sample_biblio(); > my $item = $builder->build_sample_item({ biblionumber => $biblio->biblionumber }); > my $hold = $builder->build_object({ class => 'Koha::Holds', value => { itemnumber => $item->itemnumber } }); > >- my @embeds = ('items'); >+ my @embeds = ( >+ { >+ accessor => 'items' >+ } >+ ); > >- my $biblio_api = $biblio->to_api(\@embeds); >+ my $biblio_api = $biblio->to_api({ embed => \@embeds }); > > ok(exists $biblio_api->{items}, 'Items where embedded in biblio results'); > is($biblio_api->{items}->[0]->{item_id}, $item->itemnumber, 'Item matches'); > ok(!exists $biblio_api->{items}->[0]->{holds}, 'No holds info should be embedded yet'); > >- @embeds = ('items.holds'); >- $biblio_api = $biblio->to_api(\@embeds); >+ @embeds = ( >+ { >+ accessor => 'items', >+ children => [ >+ { >+ accessor => 'holds' >+ } >+ ] >+ } >+ ); >+ $biblio_api = $biblio->to_api({ embed => \@embeds }); > > ok(exists $biblio_api->{items}, 'Items where embedded in biblio results'); > is($biblio_api->{items}->[0]->{item_id}, $item->itemnumber, 'Item still matches'); > ok(exists $biblio_api->{items}->[0]->{holds}, 'Holds info should be embedded'); > is($biblio_api->{items}->[0]->{holds}->[0]->{hold_id}, $hold->reserve_id, 'Hold matches'); > >+ my $hold_api = $hold->to_api( >+ { >+ embed => [ >+ { >+ accessor => 'item' >+ } >+ ] >+ } >+ ); >+ >+ is( ref($hold_api->{item}), 'HASH', 'Single nested object works correctly' ); >+ is( $hold_api->{item}->{item_id}, $item->itemnumber, 'Object embedded correctly' ); >+ > $schema->storage->txn_rollback; > }; > >diff --git a/t/db_dependent/Koha/Objects.t b/t/db_dependent/Koha/Objects.t >index 592ab40866..0ad88a20d3 100644 >--- a/t/db_dependent/Koha/Objects.t >+++ b/t/db_dependent/Koha/Objects.t >@@ -283,7 +283,7 @@ subtest '->search() tests' => sub { > > subtest "to_api() tests" => sub { > >- plan tests => 4; >+ plan tests => 18; > > $schema->storage->txn_begin; > >@@ -303,6 +303,77 @@ subtest "to_api() tests" => sub { > is_deeply( $cities_api->[0], $city_1->to_api, 'to_api returns the individual objects with ->to_api' ); > is_deeply( $cities_api->[1], $city_2->to_api, 'to_api returns the individual objects with ->to_api' ); > >+ my $biblio_1 = $builder->build_sample_biblio(); >+ my $item_1 = $builder->build_sample_item({ biblionumber => $biblio_1->biblionumber }); >+ my $hold_1 = $builder->build_object( >+ { >+ class => 'Koha::Holds', >+ value => { itemnumber => $item_1->itemnumber } >+ } >+ ); >+ >+ my $biblio_2 = $builder->build_sample_biblio(); >+ my $item_2 = $builder->build_sample_item({ biblionumber => $biblio_2->biblionumber }); >+ my $hold_2 = $builder->build_object( >+ { >+ class => 'Koha::Holds', >+ value => { itemnumber => $item_2->itemnumber } >+ } >+ ); >+ >+ my @embed = ( >+ { >+ accessor => 'items' >+ } >+ ); >+ >+ my $i = 0; >+ my @items = ( $item_1, $item_2 ); >+ my @holds = ( $hold_1, $hold_2 ); >+ >+ my $biblios_api = Koha::Biblios->search( >+ { >+ biblionumber => [ $biblio_1->biblionumber, $biblio_2->biblionumber ] >+ } >+ )->to_api( { embed => \@embed } ); >+ >+ foreach my $biblio_api ( @{ $biblios_api } ) { >+ ok(exists $biblio_api->{items}, 'Items where embedded in biblio results'); >+ is($biblio_api->{items}->[0]->{item_id}, $items[$i]->itemnumber, 'Item matches'); >+ ok(!exists $biblio_api->{items}->[0]->{holds}, 'No holds info should be embedded yet'); >+ >+ $i++; >+ } >+ >+ # One more level >+ @embed = ( >+ { >+ accessor => 'items', >+ children => [ >+ { >+ accessor => 'holds' >+ } >+ ] >+ } >+ ); >+ $i = 0; >+ >+ $biblios_api = Koha::Biblios->search( >+ { >+ biblionumber => [ $biblio_1->biblionumber, $biblio_2->biblionumber ] >+ } >+ )->to_api( { embed => \@embed } ); >+ >+ foreach my $biblio_api ( @{ $biblios_api } ) { >+ >+ ok(exists $biblio_api->{items}, 'Items where embedded in biblio results'); >+ is($biblio_api->{items}->[0]->{item_id}, $items[$i]->itemnumber, 'Item still matches'); >+ ok(exists $biblio_api->{items}->[0]->{holds}, 'Holds info should be embedded'); >+ is($biblio_api->{items}->[0]->{holds}->[0]->{hold_id}, $holds[$i]->reserve_id, 'Hold matches'); >+ >+ $i++; >+ } >+ > $schema->storage->txn_rollback; > }; > >-- >2.24.1
You cannot view the attachment while viewing its details because your browser does not support IFRAMEs.
View the attachment on a separate page
.
View Attachment As Diff
View Attachment As Raw
Actions:
View
|
Diff
|
Splinter Review
Attachments on
bug 24228
:
96543
|
96612
|
96613
|
96615
|
96622
|
96644
|
96645
|
96646
|
96685
|
96686
|
96687
|
96954
|
96955