sync naco_normalize versions

The copy in FTS.pm now matches the stored procedure, avoiding
a potential bug validating authorized headings that contain
diacritics.

Also added FIXME for the code-duplication.

Signed-off-by: Galen Charlton <gmc@esilibrary.com>

git-svn-id: svn://svn.open-ils.org/ILS/trunk@19025 dcc99617-32d9-48b4-a31d-7c20da2025e4

diff --git a/Open-ILS/src/perlmods/OpenILS/Application/Storage/FTS.pm b/Open-ILS/src/perlmods/OpenILS/Application/Storage/FTS.pm
index eb1a97f..2bad7bb 100644 (file)
--- a/Open-ILS/src/perlmods/OpenILS/Application/Storage/FTS.pm
+++ b/Open-ILS/src/perlmods/OpenILS/Application/Storage/FTS.pm
@@ -27,45 +27,66 @@ numeric_range: /\d+-\d*/
 
 GRAMMAR
 
+# FIXME - this is a copy-and-paste of the naco_normalize
+#         stored procedure
 sub naco_normalize {
 
-    my $txt = lc(shift);
+    my $str = shift;
     my $sf = shift;
 
-    $txt = NFD($txt);
-    $txt =~ s/\pM+//go; # Remove diacritics
-
-    $txt =~ s/\xE6/AE/go;   # Convert ae digraph
-    $txt =~ s/\x{153}/OE/go;# Convert oe digraph
-    $txt =~ s/\xFE/TH/go;   # Convert Icelandic thorn
-
-    $txt =~ tr/\x{2070}\x{2071}\x{2072}\x{2073}\x{2074}\x{2075}\x{2076}\x{2077}\x{2078}\x{2079}\x{207A}\x{207B}/0123456789+-/;# Convert superscript numbers
-    $txt =~ tr/\x{2080}\x{2081}\x{2082}\x{2083}\x{2084}\x{2085}\x{2086}\x{2087}\x{2088}\x{2089}\x{208A}\x{208B}/0123456889+-/;# Convert subscript numbers
-
-    $txt =~ tr/\x{0251}\x{03B1}\x{03B2}\x{0262}\x{03B3}/AABGG/;     # Convert Latin and Greek
-    $txt =~ tr/\x{2113}\xF0\!\"\(\)\-\{\}\<\>\;\:\.\?\xA1\xBF\/\\\@\*\%\=\xB1\+\xAE\xA9\x{2117}\$\xA3\x{FFE1}\xB0\^\_\~\`/LD /; # Convert Misc
-    $txt =~ tr/\'\[\]\|//d;                         # Remove Misc
-
-    if ($sf && $sf =~ /^a/o) {
-        my $commapos = index($txt,',');
-        if ($commapos > -1) {
-            if ($commapos != length($txt) - 1) {
-                my @list = split /,/, $txt;
-                my $first = shift @list;
-                $txt = $first . ',' . join(' ', @list);
-            } else {
-                $txt =~ s/,/ /go;
-            }
-        }
-    } else {
-        $txt =~ s/,/ /go;
-    }
-
-    $txt =~ s/\s+/ /go; # Compress multiple spaces
-    $txt =~ s/^\s+//o;  # Remove leading space
-    $txt =~ s/\s+$//o;  # Remove trailing space
-
-    return $txt;
+    # Apply NACO normalization to input string; based on
+    # http://www.loc.gov/catdir/pcc/naco/SCA_PccNormalization_Final_revised.pdf
+    #
+    # Note that unlike a strict reading of the NACO normalization rules,
+    # output is returned as lowercase instead of uppercase for compatibility
+    # with previous versions of the Evergreen naco_normalize routine.
+
+    # Convert to upper-case first; even though final output will be lowercase, doing this will
+    # ensure that the German eszett (ß) and certain ligatures (ff, fi, ffl, etc.) will be handled correctly.
+    # If there are any bugs in Perl's implementation of upcasing, they will be passed through here.
+    $str = uc $str;
+
+    # remove non-filing strings
+    $str =~ s/\x{0098}.*?\x{009C}//g;
+
+    $str = NFKD($str);
+
+    # additional substitutions - 3.6.
+    $str =~ s/\x{00C6}/AE/g;
+    $str =~ s/\x{00DE}/TH/g;
+    $str =~ s/\x{0152}/OE/g;
+    $str =~ tr/\x{0110}\x{00D0}\x{00D8}\x{0141}\x{2113}\x{02BB}\x{02BC}]['/DDOLl/d;
+
+    # transformations based on Unicode category codes
+    $str =~ s/[\p{Cc}\p{Cf}\p{Co}\p{Cs}\p{Lm}\p{Mc}\p{Me}\p{Mn}]//g;
+
+       if ($sf && $sf =~ /^a/o) {
+               my $commapos = index($str, ',');
+               if ($commapos > -1) {
+                       if ($commapos != length($str) - 1) {
+                $str =~ s/,/\x07/; # preserve first comma
+                       }
+               }
+       }
+
+    # since we've stripped out the control characters, we can now
+    # use a few as placeholders temporarily
+    $str =~ tr/+&@\x{266D}\x{266F}#/\x01\x02\x03\x04\x05\x06/;
+    $str =~ s/[\p{Pc}\p{Pd}\p{Pe}\p{Pf}\p{Pi}\p{Po}\p{Ps}\p{Sk}\p{Sm}\p{So}\p{Zl}\p{Zp}\p{Zs}]/ /g;
+    $str =~ tr/\x01\x02\x03\x04\x05\x06\x07/+&@\x{266D}\x{266F}#,/;
+
+    # decimal digits
+    $str =~ tr/\x{0660}-\x{0669}\x{06F0}-\x{06F9}\x{07C0}-\x{07C9}\x{0966}-\x{096F}\x{09E6}-\x{09EF}\x{0A66}-\x{0A6F}\x{0AE6}-\x{0AEF}\x{0B66}-\x{0B6F}\x{0BE6}-\x{0BEF}\x{0C66}-\x{0C6F}\x{0CE6}-\x{0CEF}\x{0D66}-\x{0D6F}\x{0E50}-\x{0E59}\x{0ED0}-\x{0ED9}\x{0F20}-\x{0F29}\x{1040}-\x{1049}\x{1090}-\x{1099}\x{17E0}-\x{17E9}\x{1810}-\x{1819}\x{1946}-\x{194F}\x{19D0}-\x{19D9}\x{1A80}-\x{1A89}\x{1A90}-\x{1A99}\x{1B50}-\x{1B59}\x{1BB0}-\x{1BB9}\x{1C40}-\x{1C49}\x{1C50}-\x{1C59}\x{A620}-\x{A629}\x{A8D0}-\x{A8D9}\x{A900}-\x{A909}\x{A9D0}-\x{A9D9}\x{AA50}-\x{AA59}\x{ABF0}-\x{ABF9}\x{FF10}-\x{FF19}/0-90-90-90-90-90-90-90-90-90-90-90-90-90-90-90-90-90-90-90-90-90-90-90-90-90-90-90-90-90-90-90-90-90-9/;
+
+    # intentionally skipping step 8 of the NACO algorithm; if the string
+    # gets normalized away, that's fine.
+
+    # leading and trailing spaces
+    $str =~ s/\s+/ /g;
+    $str =~ s/^\s+//;
+    $str =~ s/\s+$//g;
+
+    return lc $str;
 }
 
 #' stupid vim syntax highlighting ...

diff --git a/Open-ILS/tests/naco_normalize.t b/Open-ILS/tests/naco_normalize.t
index b43f344..34dbe03 100644 (file)
--- a/Open-ILS/tests/naco_normalize.t
+++ b/Open-ILS/tests/naco_normalize.t
@@ -2,10 +2,12 @@ use strict;
 use warnings;
 use utf8;
 
-use Test::More;
+use Test::More tests => 50;
 use Unicode::Normalize;
 use DBI;
 
+use OpenILS::Application::Storage::FTS;
+
 # This could be made better in at least one of two ways (or both);
 # 1. put PL/Perl code that doesn't require a database into external
 #    modules so that test frameworks can get at it more easily
@@ -24,11 +26,6 @@ my $db_user   = 'evergreen';
 my $db_pw     = 'evergreen';
 my $dsn       = "dbi:" . $db_driver . ":dbname=" . $db_name .';host=' . $db_host . ';port=' . $db_port;
 
-my $dbh = DBI->connect($dsn, $db_user, $db_pw, {AutoCommit => 1, pg_enable_utf8 => 1, PrintError => 0});
-if (!defined($dbh)) {
-    plan skip_all => "Failed to connect to database: $DBI::errstr";
-}
-
 binmode STDOUT, ':utf8';
 binmode STDERR, ':utf8';
 
@@ -60,24 +57,35 @@ my @test_cases = (
     [ '♭©®♯', '♭ ♯', 'other symbols' ],
 );
 
-my $sth1 = $dbh->prepare_cached('SELECT public.naco_normalize(?)');
-my $sth2 = $dbh->prepare_cached('SELECT public.naco_normalize(?, ?)');
-sub naco_normalize_wrapper {
-    my ($str, $sf) = @_;
-    if (defined $sf) {
-        $sth2->execute($str, $sf);
-        return $sth2->fetchrow_array;
-    } else {
-        $sth1->execute($str);
-        return $sth1->fetchrow_array;
-    }
-}
-
+# test copy of naco_normalize in OpenILS::Application::Storage::FTS
 foreach my $case (@test_cases) {
-    is(naco_normalize_wrapper($case->[0]), $case->[1], $case->[2]);    
+    is(OpenILS::Application::Storage::FTS::naco_normalize($case->[0]), $case->[1], $case->[2] . ' (FTS.pm)');
 }
+is(OpenILS::Application::Storage::FTS::naco_normalize('Smith, Jane. Poet, painter, and author', 'a'),
+    'smith, jane poet painter and author',
+    'retain first comma (FTS.pm)');
+
+SKIP: {
+    my $dbh = DBI->connect($dsn, $db_user, $db_pw, {AutoCommit => 1, pg_enable_utf8 => 1, PrintError => 0});
+    skip "Failed to connect to database: $DBI::errstr", 25 if (!defined($dbh));
 
-is(naco_normalize_wrapper('Smith, Jane. Poet, painter, and author', 'a'), 'smith, jane poet painter and author', 
-    'retain first comma');
+    # test stored procedure
+    my $sth1 = $dbh->prepare_cached('SELECT public.naco_normalize(?)');
+    my $sth2 = $dbh->prepare_cached('SELECT public.naco_normalize(?, ?)');
+    sub naco_normalize_wrapper {
+        my ($str, $sf) = @_;
+        if (defined $sf) {
+            $sth2->execute($str, $sf);
+            return $sth2->fetchrow_array;
+        } else {
+            $sth1->execute($str);
+            return $sth1->fetchrow_array;
+        }
+    }
 
-done_testing;
+    foreach my $case (@test_cases) {
+        is(naco_normalize_wrapper($case->[0]), $case->[1], $case->[2] . ' (stored procedure)');
+    }
+    is(naco_normalize_wrapper('Smith, Jane. Poet, painter, and author', 'a'), 'smith, jane poet painter and author',
+        'retain first comma (stored procedure)');
+}