From 44e1d44b33beb12538361ea28c507c12806429d0 Mon Sep 17 00:00:00 2001 From: Jared Camins-Esakov Date: Thu, 20 Sep 2012 07:39:16 -0400 Subject: [PATCH] Bug 8726 follow-up: fix QA issues Fixes several perlcritic complaints, and some overflow in the configuration page. Also notes that Did You Mean is not yet enabled on the staff client. Signed-off-by: Jared Camins-Esakov Sorry about the problematic last attempt at uploading. I missed a patch when squashing. It is now included. --- Koha/SuggestionEngine/Base.pm | 48 +------------------ Koha/SuggestionEngine/Plugin/AuthorityFile.pm | 22 ++++++++- Koha/SuggestionEngine/Plugin/ExplodedTerms.pm | 22 ++++++++- Koha/SuggestionEngine/Plugin/Null.pm | 22 ++++++++- .../intranet-tmpl/prog/en/css/staff-global.css | 4 -- .../prog/en/modules/admin/didyoumean.tt | 11 +++-- t/SuggestionEngine.t | 8 ++-- t/SuggestionEngine_AuthorityFile.t | 2 +- t/SuggestionEngine_ExplodedTerms.t | 2 +- 9 files changed, 75 insertions(+), 66 deletions(-) diff --git a/Koha/SuggestionEngine/Base.pm b/Koha/SuggestionEngine/Base.pm index 5c52e2b..9565a7e 100644 --- a/Koha/SuggestionEngine/Base.pm +++ b/Koha/SuggestionEngine/Base.pm @@ -34,9 +34,9 @@ B - get suggestions for the search described in $param->{'search'}, and return them in a hashref with the suggestions as keys and relevance as values. -The following variables must be defined in each filter: - our $NAME ='Filter'; - our $VERSION = '1.0'; +B - return a string with the name of the plugin. + +B - return a string with the version of the plugin. These methods may be overriden: @@ -123,46 +123,4 @@ sub get_suggestions { return; } -=head2 NAME - - my $name = $plugin->NAME; - -Getter function for plugin names. - -=cut - -sub NAME { - my $self = shift; - my $package = ref $self || $self; - return eval '$' . $package . '::NAME'; -} - -=head2 VERSION - - my $version = $plugin->VERSION; - -Getter function for plugin versions. - -=cut - -sub VERSION { - my $self = shift; - my $package = ref $self || $self; - return eval '$' . $package . '::VERSION'; -} - -=head2 DESCRIPTION - - my $description = $plugin->DESCRIPTION; - -Getter function for plugin descriptions. - -=cut - -sub DESCRIPTION { - my $self = shift; - my $package = ref $self || $self; - return eval '$' . $package . '::DESCRIPTION'; -} - 1; diff --git a/Koha/SuggestionEngine/Plugin/AuthorityFile.pm b/Koha/SuggestionEngine/Plugin/AuthorityFile.pm index 54a7248..38e3a54 100644 --- a/Koha/SuggestionEngine/Plugin/AuthorityFile.pm +++ b/Koha/SuggestionEngine/Plugin/AuthorityFile.pm @@ -35,8 +35,24 @@ use warnings; use Carp; use base qw(Koha::SuggestionEngine::Base); -our $NAME = 'AuthorityFile'; -our $VERSION = '1.0'; + +=head2 NAME + my $name = $plugin->NAME; + +=cut + +sub NAME { + return 'AuthorityFile'; +} + +=head2 VERSION + my $version = $plugin->VERSION; + +=cut + +sub VERSION { + return '1.1'; +} =head2 get_suggestions @@ -85,3 +101,5 @@ sub get_suggestions { } return \@results; } + +1; diff --git a/Koha/SuggestionEngine/Plugin/ExplodedTerms.pm b/Koha/SuggestionEngine/Plugin/ExplodedTerms.pm index a380261..c0c6166 100644 --- a/Koha/SuggestionEngine/Plugin/ExplodedTerms.pm +++ b/Koha/SuggestionEngine/Plugin/ExplodedTerms.pm @@ -37,8 +37,24 @@ use Carp; use C4::Templates qw(gettemplate); # This is necessary for translatability use base qw(Koha::SuggestionEngine::Base); -our $NAME = 'ExplodedTerms'; -our $VERSION = '1.0'; + +=head2 NAME + my $name = $plugin->NAME; + +=cut + +sub NAME { + return 'ExplodedTerms'; +} + +=head2 VERSION + my $version = $plugin->VERSION; + +=cut + +sub VERSION { + return '1.0'; +} =head2 get_suggestions @@ -85,3 +101,5 @@ sub get_suggestions { }; } return \@results; } + +1; diff --git a/Koha/SuggestionEngine/Plugin/Null.pm b/Koha/SuggestionEngine/Plugin/Null.pm index 307e035..bc1134d 100644 --- a/Koha/SuggestionEngine/Plugin/Null.pm +++ b/Koha/SuggestionEngine/Plugin/Null.pm @@ -36,8 +36,24 @@ use warnings; use Carp; use base qw(Koha::SuggestionEngine::Base); -our $NAME = 'Null'; -our $VERSION = '1.0'; + +=head2 NAME + my $name = $plugin->NAME; + +=cut + +sub NAME { + return 'Null'; +} + +=head2 VERSION + my $version = $plugin->VERSION; + +=cut + +sub VERSION { + return '1.1'; +} =head2 get_suggestions @@ -58,3 +74,5 @@ sub get_suggestions { return \@result; } + +1; diff --git a/koha-tmpl/intranet-tmpl/prog/en/css/staff-global.css b/koha-tmpl/intranet-tmpl/prog/en/css/staff-global.css index 8acdbf5..96a34f8 100644 --- a/koha-tmpl/intranet-tmpl/prog/en/css/staff-global.css +++ b/koha-tmpl/intranet-tmpl/prog/en/css/staff-global.css @@ -2429,10 +2429,6 @@ ul.ui-tabs-nav li { width: 260px; } -#didyoumeanlegend { - float: right; -} - .pluginlist { padding-bottom: 10px; } diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/admin/didyoumean.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/admin/didyoumean.tt index b534fed..8d2ae52 100644 --- a/koha-tmpl/intranet-tmpl/prog/en/modules/admin/didyoumean.tt +++ b/koha-tmpl/intranet-tmpl/prog/en/modules/admin/didyoumean.tt @@ -3,8 +3,8 @@ [% FOREACH plugin IN plugins %]
- [% IF plugin.enabled %][% ELSE %][% END %] -
+ [% IF plugin.enabled %][% ELSE %][% END %] +
[% SWITCH plugin.name %] [% CASE 'AuthorityFile' %] @@ -81,16 +81,17 @@
Please put the Did you mean? plugins in order by significance, from most significant to least significant, and check the box to enable those - plugins that you want to use. + plugins that you want to use. (NOTE: Did you mean? functionality + is not yet enabled on the staff client)
OPAC - [% PROCESS pluginlist plugins=OPACpluginlist %] + [% PROCESS pluginlist plugins=OPACpluginlist type='opac' %]
Intranet - [% PROCESS pluginlist plugins=INTRApluginlist %] + [% PROCESS pluginlist plugins=INTRApluginlist type='intranet' %]
Cancel
diff --git a/t/SuggestionEngine.t b/t/SuggestionEngine.t index 67a4949..eed6fe8 100755 --- a/t/SuggestionEngine.t +++ b/t/SuggestionEngine.t @@ -20,15 +20,15 @@ foreach my $plugin (@installed_plugins) { ok(grep($plugin, @available_plugins), "Found plugin $plugin"); } -my $suggestor = Koha::SuggestionEngine->new( { plugins => ( 'ABCD::EFGH::IJKL' ) } ); +my $suggestor = Koha::SuggestionEngine->new( { plugins => [ 'ABCD::EFGH::IJKL' ] } ); is(ref($suggestor), 'Koha::SuggestionEngine', 'Created suggestion engine with invalid plugin'); is(scalar @{ $suggestor->get_suggestions({ 'search' => 'books' }) }, 0 , 'Request suggestions with empty suggestor'); -$suggestor = Koha::SuggestionEngine->new( { plugins => ( 'Null' ) } ); +$suggestor = Koha::SuggestionEngine->new( { plugins => [ 'Null' ] } ); is(ref($suggestor->plugins->[0]), 'Koha::SuggestionEngine::Plugin::Null', 'Created record suggestor with implicitly scoped Null filter'); -$suggestor = Koha::SuggestionEngine->new( { plugins => ( 'Koha::SuggestionEngine::Plugin::Null' ) } ); +$suggestor = Koha::SuggestionEngine->new( { plugins => [ 'Koha::SuggestionEngine::Plugin::Null' ] } ); is(ref($suggestor->plugins->[0]), 'Koha::SuggestionEngine::Plugin::Null', 'Created record suggestor with explicitly scoped Null filter'); my $suggestions = $suggestor->get_suggestions({ 'search' => 'books' }); @@ -38,7 +38,7 @@ is_deeply($suggestions->[0], { 'search' => 'book', label => 'Book!', relevance = $suggestions = $suggestor->get_suggestions({ 'search' => 'silliness' }); eval { - $suggestor = Koha::SuggestionEngine->new( { plugins => ( 'Koha::SuggestionEngine::Plugin::Null' ) } ); + $suggestor = Koha::SuggestionEngine->new( { plugins => [ 'Koha::SuggestionEngine::Plugin::Null' ] } ); undef $suggestor; }; ok(!$@, 'Destroyed suggestor successfully'); diff --git a/t/SuggestionEngine_AuthorityFile.t b/t/SuggestionEngine_AuthorityFile.t index b9ab35b..e63dd94 100755 --- a/t/SuggestionEngine_AuthorityFile.t +++ b/t/SuggestionEngine_AuthorityFile.t @@ -33,7 +33,7 @@ $module->mock('SearchAuthorities', sub { } ], 1 }); -my $suggestor = Koha::SuggestionEngine->new( { plugins => ( 'AuthorityFile' ) } ); +my $suggestor = Koha::SuggestionEngine->new( { plugins => [ 'AuthorityFile' ] } ); is(ref($suggestor), 'Koha::SuggestionEngine', 'Created suggestion engine'); my $result = $suggestor->get_suggestions({search => 'Cookery'}); diff --git a/t/SuggestionEngine_ExplodedTerms.t b/t/SuggestionEngine_ExplodedTerms.t index d597aa1..52683b2 100755 --- a/t/SuggestionEngine_ExplodedTerms.t +++ b/t/SuggestionEngine_ExplodedTerms.t @@ -9,7 +9,7 @@ BEGIN { use_ok('Koha::SuggestionEngine'); } -my $suggestor = Koha::SuggestionEngine->new( { plugins => ( 'ExplodedTerms' ) } ); +my $suggestor = Koha::SuggestionEngine->new( { plugins => [ 'ExplodedTerms' ] } ); is(ref($suggestor), 'Koha::SuggestionEngine', 'Created suggestion engine'); my $result = $suggestor->get_suggestions({search => 'Cookery'}); -- 1.7.2.5