Attachment 118657 Details for Bug 26351 – Bug 26351: Add call_recursive() as a replacement for call()

[patch] Bug 26351: Add call_recursive() as a replacement for call()

Bug-26351-Add-callrecursive-as-a-replacement-for-c.patch (text/plain), 7.48 KB, created by Kyle M Hall (khall) on 2021-03-23 13:44:32 UTC

(hide)

Description:

Filename:

MIME Type:

Creator: Kyle M Hall (khall)

Created: 2021-03-23 13:44:32 UTC

Size: 7.48 KB

patch

obsolete

>From 7c18d9094c29bb8e4688e435067a30aba1a3393d Mon Sep 17 00:00:00 2001
>From: Kyle M Hall <kyle@bywatersolutions.com>
>Date: Thu, 14 Jan 2021 09:44:14 -0500
>Subject: [PATCH] Bug 26351: Add call_recursive() as a replacement for call()
>
>The method call() is not sufficient for barcode transformations. It's
>possible that more than one barcode transformation plugin will be
>installed. call_recursive() takes the output of the first plugin and
>uses it as the input for the next plugin and so on. This allowes each
>plugin to see the current version of the barcode and modify it if
>necessary.
>---
> C4/Circulation.pm                     |  2 +-
> Koha/Plugins.pm                       | 35 ++++++++++++++++++++++
> t/db_dependent/Koha/Plugins/Plugins.t | 34 +++++++++++++++++++--
> t/lib/Koha/Plugin/TestBarcodes.pm     | 43 +++++++++++++++++++++++++++
> t/lib/Koha/Plugin/TestBarcodes2.pm    | 43 +++++++++++++++++++++++++++
> 5 files changed, 154 insertions(+), 3 deletions(-)
> create mode 100644 t/lib/Koha/Plugin/TestBarcodes.pm
> create mode 100644 t/lib/Koha/Plugin/TestBarcodes2.pm
>
>diff --git a/C4/Circulation.pm b/C4/Circulation.pm
>index 9032f434a3..5e5624dbf1 100644
>--- a/C4/Circulation.pm
>+++ b/C4/Circulation.pm
>@@ -178,7 +178,7 @@ sub barcodedecode {
>     my ($barcode, $filter) = @_;
>     my $branch = C4::Context::mybranch();
>     $filter = C4::Context->preference('itemBarcodeInputFilter') unless $filter;
>-    ($barcode) = Koha::Plugins->call('item_barcode_transform',  $barcode ) || $barcode;
>+    ($barcode) = Koha::Plugins->call_recursive('item_barcode_transform',  $barcode );
>     $filter or return $barcode;     # ensure filter is defined, else return untouched barcode
> 	if ($filter eq 'whitespace') {
> 		$barcode =~ s/\s//g;
>diff --git a/Koha/Plugins.pm b/Koha/Plugins.pm
>index 36e6090415..bedd220b6f 100644
>--- a/Koha/Plugins.pm
>+++ b/Koha/Plugins.pm
>@@ -82,6 +82,41 @@ sub call {
>     return @responses;
> }
> 
>+=head2 call_recursive
>+
>+Calls a plugin method for all enabled plugins,
>+passing the return value from the previous plugin
>+to the next one.
>+
>+    @response = Koha::Plugins->call_recursive($method, @args)
>+
>+=cut
>+
>+sub call_recursive {
>+    my ( $class, $method, @args ) = @_;
>+
>+    my @responses;
>+    if ( C4::Context->config('enable_plugins') ) {
>+
>+        my @plugins = $class->new( { enable_plugins => 1 } )->GetPlugins( { method => $method } );
>+        @plugins = grep { $_->can($method) } @plugins;
>+
>+        foreach my $plugin (@plugins) {
>+            my @response = eval { $plugin->$method(@args) };
>+
>+            if ($@) {
>+                warn sprintf( "Plugin error (%s): %s", $plugin->get_metadata->{name}, $@ );
>+                next;
>+            } else {
>+                @args = @response;
>+            }
>+        }
>+
>+    }
>+
>+    return @args;
>+}
>+
> =head2 GetPlugins
> 
> This will return a list of all available plugins, optionally limited by
>diff --git a/t/db_dependent/Koha/Plugins/Plugins.t b/t/db_dependent/Koha/Plugins/Plugins.t
>index a064e98edf..52938ad7d1 100755
>--- a/t/db_dependent/Koha/Plugins/Plugins.t
>+++ b/t/db_dependent/Koha/Plugins/Plugins.t
>@@ -25,7 +25,7 @@ use File::Temp qw( tempdir tempfile );
> use FindBin qw($Bin);
> use Module::Load::Conditional qw(can_load);
> use Test::MockModule;
>-use Test::More tests => 54;
>+use Test::More tests => 55;
> 
> use C4::Context;
> use Koha::Database;
>@@ -78,6 +78,36 @@ subtest 'call() tests' => sub {
>     $schema->storage->txn_rollback;
> };
> 
>+subtest 'call_recursive() tests' => sub {
>+    plan tests => 6;
>+
>+    $schema->storage->txn_begin;
>+    # Temporarily remove any installed plugins data
>+    Koha::Plugins::Methods->delete;
>+
>+    t::lib::Mocks::mock_config('enable_plugins', 1);
>+    my $plugins = Koha::Plugins->new({ enable_plugins => 1 });
>+    my @plugins = $plugins->InstallPlugins;
>+    foreach my $plugin (@plugins) {
>+        $plugin->enable();
>+    }
>+
>+    my (@responses) = Koha::Plugins->call_recursive('item_barcode_transform', 1);
>+    is( scalar @responses, 1, "Got back one element" );
>+    is( $responses[0], 4, "Got expected response" );
>+
>+    (@responses) = Koha::Plugins->call_recursive('item_barcode_transform', 'abcd');
>+    is( scalar @responses, 1, "Got back one element" );
>+    is( $responses[0], 'abcd', "Got expected response" );
>+
>+    t::lib::Mocks::mock_config('enable_plugins', 0);
>+    (@responses) = Koha::Plugins->call_recursive('item_barcode_transform', 1);
>+    is( scalar @responses, 1, "Got back one element" );
>+    is( $responses[0], 1, "call_recursive should return the original arguments if plugins are disabled" );
>+
>+    $schema->storage->txn_rollback;
>+};
>+
> subtest 'GetPlugins() tests' => sub {
> 
>     plan tests => 2;
>@@ -96,7 +126,7 @@ subtest 'GetPlugins() tests' => sub {
> 
>     @plugins = $plugins->GetPlugins({ metadata => { my_example_tag  => 'find_me' }, all => 1 });
>     @names = map { $_->get_metadata()->{'name'} } @plugins;
>-    is( scalar @names, 2, "Only two plugins found via a metadata tag" );
>+    is( scalar @names, 4, "Only four plugins found via a metadata tag" );
> 
>     $schema->storage->txn_rollback;
> };
>diff --git a/t/lib/Koha/Plugin/TestBarcodes.pm b/t/lib/Koha/Plugin/TestBarcodes.pm
>new file mode 100644
>index 0000000000..976aa5131f
>--- /dev/null
>+++ b/t/lib/Koha/Plugin/TestBarcodes.pm
>@@ -0,0 +1,43 @@
>+package Koha::Plugin::TestBarcodes;
>+
>+use Scalar::Util qw( looks_like_number );
>+
>+## It's good practice to use Modern::Perl
>+use Modern::Perl;
>+
>+## Required for all plugins
>+use base qw(Koha::Plugins::Base);
>+
>+our $VERSION = 1.01;
>+our $metadata = {
>+    name            => 'TestBarcodes Plugin',
>+    author          => 'Kyle M Hall',
>+    description     => 'TestBarcodes plugin',
>+    date_authored   => '2013-01-14',
>+    date_updated    => '2013-01-14',
>+    minimum_version => '3.11',
>+    maximum_version => undef,
>+    version         => $VERSION,
>+    my_example_tag  => 'find_me',
>+};
>+
>+sub new {
>+    my ( $class, $args ) = @_;
>+    $args->{'metadata'} = $metadata;
>+    my $self = $class->SUPER::new($args);
>+    return $self;
>+}
>+
>+sub item_barcode_transform {
>+    my ( $self, $barcode ) = @_;
>+    return $barcode unless looks_like_number( $barcode );
>+    return $barcode + 1;
>+}
>+
>+sub patron_barcode_transform {
>+    my ( $self, $barcode ) = @_;
>+    return $barcode unless looks_like_number( $barcode );
>+    return $barcode + 1;
>+}
>+
>+1;
>diff --git a/t/lib/Koha/Plugin/TestBarcodes2.pm b/t/lib/Koha/Plugin/TestBarcodes2.pm
>new file mode 100644
>index 0000000000..1b326d564d
>--- /dev/null
>+++ b/t/lib/Koha/Plugin/TestBarcodes2.pm
>@@ -0,0 +1,43 @@
>+package Koha::Plugin::TestBarcodes2;
>+
>+use Scalar::Util qw( looks_like_number );
>+
>+## It's good practice to use Modern::Perl
>+use Modern::Perl;
>+
>+## Required for all plugins
>+use base qw(Koha::Plugins::Base);
>+
>+our $VERSION = 1.01;
>+our $metadata = {
>+    name            => 'TestBarcodes2 Plugin',
>+    author          => 'Kyle M Hall',
>+    description     => 'TestBarcodes2 plugin',
>+    date_authored   => '2013-01-14',
>+    date_updated    => '2013-01-14',
>+    minimum_version => '3.11',
>+    maximum_version => undef,
>+    version         => $VERSION,
>+    my_example_tag  => 'find_me',
>+};
>+
>+sub new {
>+    my ( $class, $args ) = @_;
>+    $args->{'metadata'} = $metadata;
>+    my $self = $class->SUPER::new($args);
>+    return $self;
>+}
>+
>+sub item_barcode_transform {
>+    my ( $self, $barcode ) = @_;
>+    return $barcode unless looks_like_number( $barcode );
>+    return $barcode + 2;
>+}
>+
>+sub patron_barcode_transform {
>+    my ( $self, $barcode ) = @_;
>+    return $barcode unless looks_like_number( $barcode );
>+    return $barcode + 2;
>+}
>+
>+1;
>-- 
>2.24.1 (Apple Git-126)

Actions: View | Diff | Splinter Review

Attachments on bug 26351: 109532 | 109548 | 109671 | 110844 | 110846 | 111575 | 111577 | 111578 | 111579 | 111862 | 111863 | 111894 | 111916 | 111917 | 111918 | 111919 | 111920 | 111921 | 111922 | 113571 | 113572 | 113573 | 113574 | 113575 | 113576 | 113577 | 113578 | 115172 | 115173 | 115174 | 115175 | 115176 | 115177 | 115178 | 115179 | 115180 | 118649 | 118650 | 118651 | 118652 | 118653 | 118654 | 118655 | 118656 | 118657 | 118658 | 118681 | 118682 | 118683 | 118684 | 118685 | 118686 | 118687 | 118688 | 118689 | 118690 | 122433 | 122434 | 122435 | 122436 | 122437 | 122438 | 122439 | 122440 | 122441 | 122442 | 124258 | 124259 | 124260 | 124261 | 124262 | 124263 | 124264 | 124265 | 124266 | 124313 | 125447 | 125763 | 125764 | 125765