From aad1b48c4151d56c882afe9011df7de4a7bc3464 Mon Sep 17 00:00:00 2001 From: Jonathan Druart Date: Tue, 15 Dec 2015 10:21:02 +0000 Subject: [PATCH] Bug 15380: Move Koha::Authority to Koha::MetadataRecord::Authority MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The existing Koha::Authority does not use Koha::Objects and does not exclusively deal with DB objects. It makes much sense to move it to let the space free for a Koha::Authority and Koha::Authorities modules based on Koha::Object. Signed-off-by: Marc VĂ©ron --- C4/AuthoritiesMarc.pm | 4 ++-- Koha/Exporter/Record.pm | 2 +- Koha/Filter/MARC/EmbedSeeFromHeadings.pm | 4 ++-- Koha/{ => MetadataRecord}/Authority.pm | 20 ++++++++++---------- authorities/merge.pl | 8 ++++---- misc/export_records.pl | 2 +- svc/records/preview | 4 ++-- t/db_dependent/Koha_Authority.t | 18 +++++++++--------- .../RecordProcessor_EmbedSeeFromHeadings.t | 4 ++-- tools/batch_record_modification.pl | 6 +++--- tools/export.pl | 2 +- 11 files changed, 37 insertions(+), 37 deletions(-) rename Koha/{ => MetadataRecord}/Authority.pm (84%) diff --git a/C4/AuthoritiesMarc.pm b/C4/AuthoritiesMarc.pm index dd8be73..b1a7196 100644 --- a/C4/AuthoritiesMarc.pm +++ b/C4/AuthoritiesMarc.pm @@ -26,7 +26,7 @@ use C4::AuthoritiesMarc::MARC21; use C4::AuthoritiesMarc::UNIMARC; use C4::Charset; use C4::Log; -use Koha::Authority; +use Koha::MetadataRecord::Authority; use vars qw($VERSION @ISA @EXPORT); @@ -801,7 +801,7 @@ Returns MARC::Record of the authority passed in parameter. sub GetAuthority { my ($authid)=@_; - my $authority = Koha::Authority->get_from_authid($authid); + my $authority = Koha::MetadataRecord::Authority->get_from_authid($authid); return unless $authority; return ($authority->record); } diff --git a/Koha/Exporter/Record.pm b/Koha/Exporter/Record.pm index 0dbd7cd..ee76d8a 100644 --- a/Koha/Exporter/Record.pm +++ b/Koha/Exporter/Record.pm @@ -52,7 +52,7 @@ sub _get_record_for_export { sub _get_authority_for_export { my ($params) = @_; my $authid = $params->{authid} || return; - my $authority = Koha::Authority->get_from_authid($authid); + my $authority = Koha::MetadataRecord::Authority->get_from_authid($authid); return unless $authority; return $authority->record; } diff --git a/Koha/Filter/MARC/EmbedSeeFromHeadings.pm b/Koha/Filter/MARC/EmbedSeeFromHeadings.pm index fc8d1eb..1a4a143 100644 --- a/Koha/Filter/MARC/EmbedSeeFromHeadings.pm +++ b/Koha/Filter/MARC/EmbedSeeFromHeadings.pm @@ -33,7 +33,7 @@ Filter to embed see from headings into MARC records. use strict; use warnings; use Carp; -use Koha::Authority; +use Koha::MetadataRecord::Authority; use C4::Biblio qw/GetMarcFromKohaField/; use base qw(Koha::RecordProcessor::Base); @@ -83,7 +83,7 @@ sub _processrecord { next unless $authid; - my $authority = Koha::Authority->get_from_authid($authid); + my $authority = Koha::MetadataRecord::Authority->get_from_authid($authid); next unless $authority; my $auth_marc = $authority->record; my @seefrom = $auth_marc->field('4..'); diff --git a/Koha/Authority.pm b/Koha/MetadataRecord/Authority.pm similarity index 84% rename from Koha/Authority.pm rename to Koha/MetadataRecord/Authority.pm index 7097bd9..8d59771 100644 --- a/Koha/Authority.pm +++ b/Koha/MetadataRecord/Authority.pm @@ -1,4 +1,4 @@ -package Koha::Authority; +package Koha::MetadataRecord::Authority; # Copyright 2012 C & P Bibliography Services # @@ -19,7 +19,7 @@ package Koha::Authority; =head1 NAME -Koha::Authority - class to encapsulate authority records in Koha +Koha::MetadataRecord::Authority - class to encapsulate authority records in Koha =head1 SYNOPSIS @@ -45,9 +45,9 @@ __PACKAGE__->mk_accessors(qw( authid authtype )); =head2 new - my $auth = Koha::Authority->new($record); + my $auth = Koha::MetadataRecord::Authority->new($record); -Create a new Koha::Authority object based on the provided record. +Create a new Koha::MetadataRecord::Authority object based on the provided record. =cut @@ -69,9 +69,9 @@ sub new { =head2 get_from_authid - my $auth = Koha::Authority->get_from_authid($authid); + my $auth = Koha::MetadataRecord::Authority->get_from_authid($authid); -Create the Koha::Authority object associated with the provided authid. +Create the Koha::MetadataRecord::Authority object associated with the provided authid. Note that this routine currently retrieves a MARC record because authorities in Koha are MARC records by definition. This is an unfortunate but unavoidable fact. @@ -92,7 +92,7 @@ sub get_from_authid { return if ($@); $record->encoding('UTF-8'); - # NOTE: GuessAuthTypeCode has no business in Koha::Authority, which is an + # NOTE: GuessAuthTypeCode has no business in Koha::MetadataRecord::Authority, which is an # object-oriented class. Eventually perhaps there will be utility # classes in the Koha:: namespace, but there are not at the moment, # so this shim seems like the best option all-around. @@ -110,9 +110,9 @@ sub get_from_authid { =head2 get_from_breeding - my $auth = Koha::Authority->get_from_authid($authid); + my $auth = Koha::MetadataRecord::Authority->get_from_authid($authid); -Create the Koha::Authority object associated with the provided authid. +Create the Koha::MetadataRecord::Authority object associated with the provided authid. =cut @@ -130,7 +130,7 @@ sub get_from_breeding { return if ($@); $record->encoding('UTF-8'); - # NOTE: GuessAuthTypeCode has no business in Koha::Authority, which is an + # NOTE: GuessAuthTypeCode has no business in Koha::MetadataRecord::Authority, which is an # object-oriented class. Eventually perhaps there will be utility # classes in the Koha:: namespace, but there are not at the moment, # so this shim seems like the best option all-around. diff --git a/authorities/merge.pl b/authorities/merge.pl index 476b774..d74abc5 100755 --- a/authorities/merge.pl +++ b/authorities/merge.pl @@ -23,7 +23,7 @@ use CGI qw ( -utf8 ); use C4::Output; use C4::Auth; use C4::AuthoritiesMarc; -use Koha::Authority; +use Koha::MetadataRecord::Authority; use C4::Koha; use C4::Biblio; @@ -92,13 +92,13 @@ else { push @errors, { code => "WRONG_COUNT", value => scalar(@authid) }; } else { - my $recordObj1 = Koha::Authority->get_from_authid($authid[0]) || Koha::Authority->new(); + my $recordObj1 = Koha::MetadataRecord::Authority->get_from_authid($authid[0]) || Koha::MetadataRecord::Authority->new(); my $recordObj2; if (defined $mergereference && $mergereference eq 'breeding') { - $recordObj2 = Koha::Authority->get_from_breeding($authid[1]) || Koha::Authority->new(); + $recordObj2 = Koha::MetadataRecord::Authority->get_from_breeding($authid[1]) || Koha::MetadataRecord::Authority->new(); } else { - $recordObj2 = Koha::Authority->get_from_authid($authid[1]) || Koha::Authority->new(); + $recordObj2 = Koha::MetadataRecord::Authority->get_from_authid($authid[1]) || Koha::MetadataRecord::Authority->new(); } if ($mergereference) { diff --git a/misc/export_records.pl b/misc/export_records.pl index b00dde8..e6c3d98 100755 --- a/misc/export_records.pl +++ b/misc/export_records.pl @@ -167,7 +167,7 @@ elsif ( $record_type eq 'auths' ) { : (), ( $authtype ? ( authtypecode => $authtype ) : () ), }; - # Koha::Authority is not a Koha::Object... + # Koha::MetadataRecord::Authority is not a Koha::Object... my $authorities = Koha::Database->new->schema->resultset('AuthHeader')->search( $conditions ); @record_ids = map { $_->authid } $authorities->all; } diff --git a/svc/records/preview b/svc/records/preview index 39fcb92..c1bdc67 100755 --- a/svc/records/preview +++ b/svc/records/preview @@ -23,7 +23,7 @@ use C4::Auth qw( get_template_and_user ); use C4::Biblio qw( GetMarcBiblio ); use C4::MarcModificationTemplates qw( ModifyRecordWithTemplate ); use C4::Output qw( output_html_with_http_headers ); -use Koha::Authority; +use Koha::MetadataRecord::Authority; my $query = CGI->new(); my $record_id = $query->param('record_id'); @@ -34,7 +34,7 @@ my $record; if ( $record_type eq 'biblio' ) { $record = GetMarcBiblio( $record_id ); } else { - my $authority = Koha::Authority->get_from_authid( $record_id ); + my $authority = Koha::MetadataRecord::Authority->get_from_authid( $record_id ); $record = $authority->record; } diff --git a/t/db_dependent/Koha_Authority.t b/t/db_dependent/Koha_Authority.t index 92c3998..f4203b4 100755 --- a/t/db_dependent/Koha_Authority.t +++ b/t/db_dependent/Koha_Authority.t @@ -24,7 +24,7 @@ use C4::Context; use Test::More; BEGIN { - use_ok('Koha::Authority'); + use_ok('Koha::MetadataRecord::Authority'); } my $record = MARC::Record->new; @@ -34,9 +34,9 @@ $record->add_fields( [ '150', ' ', ' ', a => 'Cooking' ], [ '450', ' ', ' ', a => 'Cookery' ], ); -my $authority = Koha::Authority->new($record); +my $authority = Koha::MetadataRecord::Authority->new($record); -is(ref($authority), 'Koha::Authority', 'Created valid Koha::Authority object'); +is(ref($authority), 'Koha::MetadataRecord::Authority', 'Created valid Koha::MetadataRecord::Authority object'); is($authority->authorized_heading(), 'Cooking', 'Authorized heading was correct'); @@ -53,15 +53,15 @@ SKIP: $authid = $row->{'authid'}; } skip 'No authorities', 3 unless $authid; - $authority = Koha::Authority->get_from_authid($authid); + $authority = Koha::MetadataRecord::Authority->get_from_authid($authid); - is(ref($authority), 'Koha::Authority', 'Retrieved valid Koha::Authority object'); + is(ref($authority), 'Koha::MetadataRecord::Authority', 'Retrieved valid Koha::MetadataRecord::Authority object'); is($authority->authid, $authid, 'Object authid is correct'); is($authority->record->field('001')->data(), $authid, 'Retrieved correct record'); - $authority = Koha::Authority->get_from_authid('alphabetsoup'); + $authority = Koha::MetadataRecord::Authority->get_from_authid('alphabetsoup'); is($authority, undef, 'No invalid record is retrieved'); } @@ -77,15 +77,15 @@ SKIP: } skip 'No authorities in reservoir', 3 unless $import_record_id; - $authority = Koha::Authority->get_from_breeding($import_record_id); + $authority = Koha::MetadataRecord::Authority->get_from_breeding($import_record_id); - is(ref($authority), 'Koha::Authority', 'Retrieved valid Koha::Authority object'); + is(ref($authority), 'Koha::MetadataRecord::Authority', 'Retrieved valid Koha::MetadataRecord::Authority object'); is($authority->authid, undef, 'Records in reservoir do not have an authid'); is(ref($authority->record), 'MARC::Record', 'MARC record attached to authority'); - $authority = Koha::Authority->get_from_breeding('alphabetsoup'); + $authority = Koha::MetadataRecord::Authority->get_from_breeding('alphabetsoup'); is($authority, undef, 'No invalid record is retrieved from reservoir'); } diff --git a/t/db_dependent/RecordProcessor_EmbedSeeFromHeadings.t b/t/db_dependent/RecordProcessor_EmbedSeeFromHeadings.t index 0b9d5f0..664a0fa 100755 --- a/t/db_dependent/RecordProcessor_EmbedSeeFromHeadings.t +++ b/t/db_dependent/RecordProcessor_EmbedSeeFromHeadings.t @@ -21,7 +21,7 @@ use strict; use warnings; use File::Spec; use MARC::Record; -use Koha::Authority; +use Koha::MetadataRecord::Authority; use Test::More; use Test::MockModule; @@ -82,7 +82,7 @@ subtest "EmbedSeeFromHeadings should skip holdings fields" => sub { ); - my $koha_authority = new Test::MockModule('Koha::Authority'); + my $koha_authority = new Test::MockModule('Koha::MetadataRecord::Authority'); $koha_authority->mock( 'get_from_authid', sub { my $auth_record = MARC::Record->new; diff --git a/tools/batch_record_modification.pl b/tools/batch_record_modification.pl index f96ec5d..51095c3 100755 --- a/tools/batch_record_modification.pl +++ b/tools/batch_record_modification.pl @@ -29,7 +29,7 @@ use C4::AuthoritiesMarc qw( BuildSummary GetAuthTypeCode ModAuthority ); use C4::BackgroundJob; use C4::Biblio qw( GetMarcBiblio ModBiblio ); use C4::MarcModificationTemplates qw( GetModificationTemplateActions GetModificationTemplates ModifyRecordWithTemplate ); -use Koha::Authority; +use Koha::MetadataRecord::Authority; my $input = new CGI; our $dbh = C4::Context->dbh; @@ -128,7 +128,7 @@ if ( $op eq 'form' ) { push @records, $biblio; } else { # Retrieve authority information - my $authority = Koha::Authority->get_from_authid( $record_id ); + my $authority = Koha::MetadataRecord::Authority->get_from_authid( $record_id ); unless ( $authority ) { push @messages, { type => 'warning', @@ -213,7 +213,7 @@ if ( $op eq 'form' ) { # Authorities my $authid = $record_id; my $error = eval { - my $authority = Koha::Authority->get_from_authid( $authid ); + my $authority = Koha::MetadataRecord::Authority->get_from_authid( $authid ); my $record = $authority->record; ModifyRecordWithTemplate( $mmtid, $record ); ModAuthority( $authid, $record, GetAuthTypeCode( $authid ) ); diff --git a/tools/export.pl b/tools/export.pl index 0186eaf..7d96834 100755 --- a/tools/export.pl +++ b/tools/export.pl @@ -168,7 +168,7 @@ if ( $op eq "export" ) { : (), ( $authtype ? ( authtypecode => $authtype ) : () ), }; - # Koha::Authority is not a Koha::Object... + # Koha::MetadataRecord::Authority is not a Koha::Object... my $authorities = Koha::Database->new->schema->resultset('AuthHeader')->search( $conditions ); @record_ids = map { $_->authid } $authorities->all; } -- 1.7.10.4