Merge remote-tracking branch 'origin/issue-338-else-nested-preserve-same-entity' into oersi

Author: fsteeg

metafacture-biblio/build.gradle

@@ -22,7 +22,12 @@ dependencies {
   implementation project(':metafacture-commons')
   implementation project(':metafacture-flowcontrol')
   implementation 'org.dspace:oclc-harvester2:0.1.12'
-  implementation 'xalan:xalan:2.7.1'
+  implementation ('xalan:xalan:2.7.0') {
+    exclude group: 'xalan', module: 'serializer'
+    exclude group: 'xercesImpl', module: 'xercesImpl'
+    exclude group: 'xml-apis', module: 'xml-apis'
+  }
+  implementation 'log4j:log4j:1.2.12'
   testImplementation 'junit:junit:4.12'
   testImplementation 'org.mockito:mockito-core:2.5.5'
 }

metafacture-biblio/src/main/java/org/metafacture/biblio/marc21/MarcXmlEncoder.java

@@ -175,7 +175,8 @@ public void literal(final String name, final String value) {
         if (currentEntity.equals("")) {
             prettyPrintIndentation();
             writeRaw(String.format(CONTROLFIELD_OPEN_TEMPLATE, name));
-            writeEscaped(value.trim());
+            if (value != null)
+                writeEscaped(value.trim());
             writeRaw(CONTROLFIELD_CLOSE);
             prettyPrintNewLine();
         } else if (!currentEntity.equals(Marc21EventNames.LEADER_ENTITY)) {

metafacture-biblio/src/test/java/org/metafacture/biblio/marc21/MarcXmlEncoderTest.java

@@ -204,4 +204,17 @@ public void sendAndClearDataWhenOnResetStream() {
         String actual = resultCollector.toString();
         assertEquals(expected, actual);
     }
+
+    @Test
+    public void shouldIgnoreNullValueOfLiteral() {
+        encoder.startRecord(RECORD_ID);
+        encoder.literal("type", null);
+        encoder.endRecord();
+        encoder.closeStream();
+        String expected = XML_DECLARATION + XML_ROOT_OPEN
+                + "<marc:record><marc:controlfield tag=\"type\"></marc:controlfield></marc:record>"
+                + XML_MARC_COLLECTION_END_TAG;
+        String actual = resultCollector.toString();
+        assertEquals(expected, actual);
+    }
 }

metamorph/build.gradle

@@ -24,8 +24,10 @@ dependencies {
   implementation project(':metafacture-flowcontrol')
   implementation project(':metafacture-mangling')
   implementation project(':metafacture-javaintegration')
+  implementation 'org.slf4j:slf4j-api:1.7.21'
   testImplementation 'junit:junit:4.12'
   testImplementation 'org.mockito:mockito-core:2.5.5'
+  testRuntimeOnly 'org.slf4j:slf4j-simple:1.7.21'
 }
 
 sourceSets {
@@ -37,3 +39,10 @@ sourceSets {
     output.resourcesDir = sourceSets.test.java.outputDir
   }
 }
+
+test {
+  testLogging {
+    showStandardStreams = true
+    exceptionFormat = 'full'
+  }
+}

metamorph/src/main/java/org/metafacture/metamorph/Metamorph.java

@@ -28,6 +28,7 @@
 import java.util.LinkedList;
 import java.util.List;
 import java.util.Map;
+import java.util.regex.Pattern;
 
 import org.metafacture.commons.ResourceUtil;
 import org.metafacture.framework.FluxCommand;
@@ -48,6 +49,8 @@
 import org.metafacture.metamorph.api.NamedValueReceiver;
 import org.metafacture.metamorph.api.NamedValueSource;
 import org.metafacture.metamorph.api.SourceLocation;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 import org.xml.sax.InputSource;
 
 /**
@@ -64,7 +67,9 @@
 @FluxCommand("morph")
 public final class Metamorph implements StreamPipe<StreamReceiver>, NamedValuePipe, Maps {
 
+    private static final String ELSE_NESTED_KEYWORD = "_elseNested";
     public static final String ELSE_KEYWORD = "_else";
+    public static final String ELSE_FLATTENED_KEYWORD = "_elseFlattened";
     public static final char FEEDBACK_CHAR = '@';
     public static final char ESCAPE_CHAR = '\\';
     public static final String METADATA = "__meta";
@@ -77,8 +82,7 @@ public final class Metamorph implements StreamPipe<StreamReceiver>, NamedValuePi
     private static final InterceptorFactory NULL_INTERCEPTOR_FACTORY = new NullInterceptorFactory();
     private static final Map<String, String> NO_VARS = Collections.emptyMap();
 
-    private final Registry<NamedValueReceiver> dataRegistry =
-            new WildcardRegistry<>();
+    private final Registry<NamedValueReceiver> dataRegistry = new WildcardRegistry<>();
     private final List<NamedValueReceiver> elseSources = new ArrayList<>();
 
     private final Map<String, Map<String, String>> maps = new HashMap<>();
@@ -94,6 +98,10 @@ public final class Metamorph implements StreamPipe<StreamReceiver>, NamedValuePi
     private MorphErrorHandler errorHandler = new DefaultErrorHandler();
     private int recordCount;
     private final List<FlushListener> recordEndListener = new ArrayList<>();
+    private boolean elseNested;
+    private boolean elseNestedEntityStarted;
+    private String currentLiteralName;
+    private static final Logger LOG = LoggerFactory.getLogger(Metamorph.class);
 
     protected Metamorph() {
         // package private
@@ -114,7 +122,6 @@ public Metamorph(final String morphDef, final InterceptorFactory interceptorFact
 
     public Metamorph(final String morphDef, final Map<String, String> vars,
             final InterceptorFactory interceptorFactory) {
-
         this(getInputSource(morphDef), vars, interceptorFactory);
     }
 
@@ -132,7 +139,6 @@ public Metamorph(final Reader morphDef, final InterceptorFactory interceptorFact
 
     public Metamorph(final Reader morphDef, final Map<String, String> vars,
             final InterceptorFactory interceptorFactory) {
-
         this(new InputSource(morphDef), vars, interceptorFactory);
     }
 
@@ -150,7 +156,6 @@ public Metamorph(final InputStream morphDef, final InterceptorFactory intercepto
 
     public Metamorph(final InputStream morphDef, final Map<String, String> vars,
             final InterceptorFactory interceptorFactory) {
-
         this(new InputSource(morphDef), vars, interceptorFactory);
     }
 
@@ -197,7 +202,7 @@ private void init() {
         flattener.setReceiver(new DefaultStreamReceiver() {
             @Override
             public void literal(final String name, final String value) {
-                dispatch(name, value, getElseSources());
+                dispatch(name, value, getElseSources(), false);
             }
         });
     }
@@ -215,8 +220,17 @@ public void setErrorHandler(final MorphErrorHandler errorHandler) {
     }
 
     protected void registerNamedValueReceiver(final String source, final NamedValueReceiver data) {
-        if (ELSE_KEYWORD.equals(source)) {
-            elseSources.add(data);
+        if (ELSE_NESTED_KEYWORD.equals(source)) {
+            elseNested = true;
+        }
+
+        if (ELSE_KEYWORD.equals(source) || ELSE_FLATTENED_KEYWORD.equals(source) || elseNested) {
+            if (elseSources.isEmpty()) {
+                elseSources.add(data);
+            }
+            else {
+                LOG.warn("Only one of '_else', '_elseFlattened' and '_elseNested' is allowed. Ignoring the superflous ones.");
+            }
         } else {
             dataRegistry.register(source, data);
         }
@@ -238,12 +252,11 @@ public void startRecord(final String identifier) {
         final String identifierFinal = identifier;
 
         outputStreamReceiver.startRecord(identifierFinal);
-        dispatch(StandardEventNames.ID, identifierFinal, null);
+        dispatch(StandardEventNames.ID, identifierFinal, null, false);
     }
 
     @Override
     public void endRecord() {
-
         for(final FlushListener listener: recordEndListener){
             listener.flush(recordCount, currentEntityCount);
         }
@@ -268,24 +281,20 @@ public void startEntity(final String name) {
         entityCountStack.push(Integer.valueOf(entityCount));
 
         flattener.startEntity(name);
-
-
-
     }
 
     @Override
     public void endEntity() {
-        dispatch(flattener.getCurrentPath(), "", null);
+        dispatch(flattener.getCurrentPath(), "", getElseSources(), true);
         currentEntityCount = entityCountStack.pop().intValue();
         flattener.endEntity();
-
     }
 
 
     @Override
     public void literal(final String name, final String value) {
+        currentLiteralName = name;
         flattener.literal(name, value);
-
     }
 
     @Override
@@ -306,25 +315,48 @@ public void closeStream() {
         outputStreamReceiver.closeStream();
     }
 
-    protected void dispatch(final String path, final String value, final List<NamedValueReceiver> fallback) {
-        final List<NamedValueReceiver> matchingData = findMatchingData(path, fallback);
-        if (null != matchingData) {
+    private void dispatch(final String path, final String value, final List<NamedValueReceiver> fallbackReceiver, final boolean endEntity) {
+        final List<NamedValueReceiver> matchingData = getData(path);
+
+        if (matchingData != null) {
             send(path, value, matchingData);
         }
+        else if (fallbackReceiver != null) {
+            if (endEntity) {
+                if (elseNestedEntityStarted) {
+                    outputStreamReceiver.endEntity();
+                    elseNestedEntityStarted = false;
+                }
+            }
+            else {
+                final String entityName = elseNested ? flattener.getCurrentEntityName() : null;
+
+                if (entityName != null) {
+                    if (getData(entityName) == null) {
+                        if (!elseNestedEntityStarted) {
+                            outputStreamReceiver.startEntity(entityName);
+                            elseNestedEntityStarted = true;
+                        }
+
+                        send(currentLiteralName, value, fallbackReceiver);
+                    }
+                }
+                else {
+                    send(path, value, fallbackReceiver);
+                }
+            }
+        }
     }
 
-    private List<NamedValueReceiver> findMatchingData(final String path, final List<NamedValueReceiver> fallback) {
+    private List<NamedValueReceiver> getData(final String path) {
         final List<NamedValueReceiver> matchingData = dataRegistry.get(path);
-        if (matchingData == null || matchingData.isEmpty()) {
-            return fallback;
-        }
-        return matchingData;
+        return matchingData != null && !matchingData.isEmpty() ? matchingData : null;
     }
 
-    private void send(final String key, final String value, final List<NamedValueReceiver> dataList) {
+    private void send(final String path, final String value, final List<NamedValueReceiver> dataList) {
         for (final NamedValueReceiver data : dataList) {
             try {
-                data.receive(key, value, null, recordCount, currentEntityCount);
+                data.receive(path, value, null, recordCount, currentEntityCount);
             } catch (final RuntimeException e) {
                 errorHandler.error(e);
             }
@@ -357,7 +389,7 @@ public void receive(final String name, final String value, final NamedValueSourc
         }
 
         if (name.length() != 0 && name.charAt(0) == FEEDBACK_CHAR) {
-            dispatch(name, value, null);
+            dispatch(name, value, null, false);
             return;
         }
 

metamorph/src/main/java/org/metafacture/metamorph/functions/Regexp.java

@@ -39,6 +39,9 @@ public final class Regexp extends AbstractFunction {
     public void receive(final String name, final String value,
             final NamedValueSource source, final int recordCount,
             final int entityCount) {
+        if (null == value) {
+            return;
+        }
         matcher.reset(value);
         if (null == format) {
             while (matcher.find()) {

metamorph/src/test/java/org/metafacture/metamorph/MetamorphTest.java

@@ -52,6 +52,9 @@ public final class MetamorphTest {
     @Mock
     private NamedValueReceiver namedValueReceiver;
 
+    @Mock
+    private DefaultStreamReceiver receiver = new DefaultStreamReceiver();
+
     private Metamorph metamorph;
 
     @Before
@@ -60,6 +63,7 @@ public void createSystemUnderTest() {
         metamorph.setReceiver(new DefaultStreamReceiver());
     }
 
+
     @Test
     public void shouldMapMatchingPath() {
         setupSimpleMappingMorph();

metamorph/src/test/java/org/metafacture/metamorph/TestHelpers.java

@@ -0,0 +1,56 @@
+/*
+ * Copyright 2020 hbz NRW
+ *
+ * Licensed under the Apache License, Version 2.0 the "License";
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.metafacture.metamorph;
+
+import org.metafacture.framework.StreamReceiver;
+import org.mockito.InOrder;
+import org.mockito.Mockito;
+import org.mockito.exceptions.base.MockitoAssertionError;
+
+import java.util.function.BiConsumer;
+import java.util.function.Consumer;
+import java.util.function.IntFunction;
+import java.util.function.Supplier;
+
+/**
+ * Helper functions for Metamorph tests.
+ *
+ * @author Jens Wille
+ */
+public final class TestHelpers {
+
+    public static void assertMorph(final StreamReceiver receiver, final String morphDef, final Consumer<Metamorph> in, final Consumer<Supplier<StreamReceiver>> out) {
+        assertMorph(receiver, morphDef, in, (s, f) -> out.accept(s));
+    }
+
+    public static void assertMorph(final StreamReceiver receiver, final String morphDef, final Consumer<Metamorph> in, final BiConsumer<Supplier<StreamReceiver>, IntFunction<StreamReceiver>> out) {
+        final Metamorph metamorph = InlineMorph.in(TestHelpers.class).with(morphDef).createConnectedTo(receiver);
+        final InOrder ordered = Mockito.inOrder(receiver);
+
+        try {
+            in.accept(metamorph);
+            out.accept(() -> ordered.verify(receiver), i -> ordered.verify(receiver, Mockito.times(i)));
+
+            ordered.verifyNoMoreInteractions();
+            Mockito.verifyNoMoreInteractions(receiver);
+        }
+        catch (final MockitoAssertionError e) {
+            System.out.println(Mockito.mockingDetails(receiver).printInvocations());
+            throw e;
+        }
+    }
+
+}