Merge pull request #233 from metafacture/231-addIsbnFunction

Add `isbn()` Fix function.

Author: blackwinter

README.md

@@ -529,6 +529,20 @@ Deletes duplicate values in an array.
 uniq("<sourceField>")
 ```
 
+#### `isbn`
+
+Extracts an ISBN and replaces the field value with the normalized ISBN; optionally converts and/or validates the ISBN.
+
+Options:
+
+- `to`: ISBN format to convert to (either `ISBN10` or `ISBN13`). (Default: Only normalize ISBN)
+- `verify_check_digit`: Whether the check digit should be verified. (Default: `false`)
+- `error_string`: Error message as a placeholder if the ISBN couln't be validated. (Default: `null`)
+
+```perl
+isbn("<sourceField>"[, to: "<isbnFormat>"][, verify_check_digit: "<boolean>"][, error_string: "<errorValue>"])
+```
+
 ### Selectors
 
 #### `reject`

metafix/src/main/java/org/metafacture/metafix/FixMethod.java

@@ -18,6 +18,7 @@
 
 import org.metafacture.metafix.api.FixFunction;
 import org.metafacture.metamorph.api.Maps;
+import org.metafacture.metamorph.functions.ISBN;
 import org.metafacture.metamorph.functions.Timestamp;
 import org.metafacture.metamorph.maps.FileMap;
 
@@ -359,6 +360,18 @@ public void apply(final Metafix metafix, final Record record, final List<String>
             record.transform(params.get(0), s -> String.valueOf(s.indexOf(search))); // TODO: multiple
         }
     },
+    isbn {
+        @Override
+        public void apply(final Metafix metafix, final Record record, final List<String> params, final Map<String, String> options) {
+            final ISBN isbn = new ISBN();
+
+            withOption(options, "error_string", isbn::setErrorString);
+            withOption(options, "to", isbn::setTo);
+            withOption(options, "verify_check_digit", isbn::setVerifyCheckDigit);
+
+            record.transform(params.get(0), isbn::process);
+        }
+    },
     join_field {
         @Override
         public void apply(final Metafix metafix, final Record record, final List<String> params, final Map<String, String> options) {

metafix/src/test/java/org/metafacture/metafix/MetafixMethodTest.java

@@ -1145,6 +1145,95 @@ public void shouldGetIndexOfSubstring() {
         );
     }
 
+    @Test
+    public void shouldCleanseISBN10() {
+        MetafixTestHelpers.assertFix(streamReceiver, Arrays.asList(
+                "isbn(test)"
+            ),
+            i -> {
+                i.startRecord("1");
+                i.literal("test", "ISBN: 1-.93.3-988-31-2 EUro 17.70");
+                i.endRecord();
+            },
+            o -> {
+                o.get().startRecord("1");
+                o.get().literal("test", "1933988312");
+                o.get().endRecord();
+            }
+        );
+    }
+
+    @Test
+    public void shouldConvertISBN10ToISBN13() {
+        MetafixTestHelpers.assertFix(streamReceiver, Arrays.asList(
+                "isbn(test, to: 'isbn13')"
+            ),
+            i -> {
+                i.startRecord("1");
+                i.literal("test", "1933988312");
+                i.endRecord();
+            },
+            o -> {
+                o.get().startRecord("1");
+                o.get().literal("test", "9781933988313");
+                o.get().endRecord();
+            }
+        );
+    }
+
+    @Test
+    public void shouldConvertISBN13ToISBN10() {
+        MetafixTestHelpers.assertFix(streamReceiver, Arrays.asList(
+                "isbn(test, to: 'isbn10')"
+            ),
+            i -> {
+                i.startRecord("1");
+                i.literal("test", "9781933988313");
+                i.endRecord();
+            },
+            o -> {
+                o.get().startRecord("1");
+                o.get().literal("test", "1933988312");
+                o.get().endRecord();
+            }
+        );
+    }
+
+    @Test
+    public void shouldNotProcessInvalidISBN10() {
+        MetafixTestHelpers.assertFix(streamReceiver, Arrays.asList(
+                "isbn(test, verify_check_digit: 'true')"
+            ),
+            i -> {
+                i.startRecord("1");
+                i.literal("test", "1933988313");
+                i.endRecord();
+            },
+            o -> {
+                o.get().startRecord("1");
+                o.get().endRecord();
+            }
+        );
+    }
+
+    @Test
+    public void shouldSetInvalidISBN10ToErrorString() {
+        MetafixTestHelpers.assertFix(streamReceiver, Arrays.asList(
+                "isbn(test, verify_check_digit: 'true', error_string: 'invalid')"
+            ),
+            i -> {
+                i.startRecord("1");
+                i.literal("test", "1933988313");
+                i.endRecord();
+            },
+            o -> {
+                o.get().startRecord("1");
+                o.get().literal("test", "invalid");
+                o.get().endRecord();
+            }
+        );
+    }
+
     @Test
     public void shouldJoinArrayField() {
         MetafixTestHelpers.assertFix(streamReceiver, Arrays.asList(

metafix/src/test/resources/org/metafacture/metafix/integration/method/fromJson/toJson/isbn/expected.json

@@ -0,0 +1,6 @@
+{
+  "test_1" : "9783894018109",
+  "test_2" : "ungültig",
+  "test_3" : "9783442151479",
+  "test_4" : "3821808187"
+}

metafix/src/test/resources/org/metafacture/metafix/integration/method/fromJson/toJson/isbn/input.json

@@ -0,0 +1,6 @@
+{
+  "test_1" : "978-3-89401-810-9",
+  "test_2" : "978-3-89401-810-9",
+  "test_3" : "3442151473",
+  "test_4" : "978-3-8218-0818-5"
+}

metafix/src/test/resources/org/metafacture/metafix/integration/method/fromJson/toJson/isbn/test.fix

@@ -0,0 +1,4 @@
+isbn("test_1",to:"clean")
+isbn("test_2",to:"clean",verify_check_digit:"true",error_string:"ungültig")
+isbn("test_3",to:"ISBN13",verify_check_digit:"true",error_string:"ungültig")
+isbn("test_4",to:"ISBN10",verify_check_digit:"true",error_string:"ungültig")

metafix/src/test/resources/org/metafacture/metafix/integration/method/fromJson/toJson/isbn/test.flux

@@ -0,0 +1,8 @@
+FLUX_DIR + "input.json"
+|open-file
+|as-records
+|decode-json
+|fix(FLUX_DIR + "test.fix")
+|encode-json(prettyPrinting="true")
+|write(FLUX_DIR + "output-metafix.json")
+;