Initial setup for a flux command to list available fix paths

See https://gitlab.com/oersi/oersi-etl/-/issues/238

Author: fsteeg

metafix/build.gradle

@@ -36,6 +36,8 @@ dependencies {
   implementation "org.metafacture:metafacture-io:${versions.metafacture}"
   implementation "org.metafacture:metafacture-javaintegration:${versions.metafacture}"
   implementation "org.metafacture:metafacture-mangling:${versions.metafacture}"
+  implementation "org.metafacture:metafacture-formatting:${versions.metafacture}"
+  implementation "org.metafacture:metafacture-triples:${versions.metafacture}"
   implementation "org.metafacture:metamorph:${versions.metafacture}"
 
   testImplementation "nl.jqno.equalsverifier:equalsverifier:${versions.equalsverifier}"

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

@@ -0,0 +1,96 @@
+/*
+ * Copyright 2023 Fabian Steeg, hbz
+ *
+ * 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.metafix;
+
+import org.metafacture.formatting.ObjectTemplate;
+import org.metafacture.framework.ObjectReceiver;
+import org.metafacture.framework.helpers.DefaultStreamPipe;
+import org.metafacture.framework.objects.Triple;
+import org.metafacture.mangling.StreamFlattener;
+import org.metafacture.triples.AbstractTripleSort.Compare;
+import org.metafacture.triples.StreamToTriples;
+import org.metafacture.triples.TripleCount;
+
+import java.io.FileNotFoundException;
+
+/**
+ * Provide a user-friendly way to list all paths available for processing in fix.
+ *
+ * @author Fabian Steeg
+ */
+public class MetafixListPaths extends DefaultStreamPipe<ObjectReceiver<String>> {
+
+    private Metafix fix;
+
+    public MetafixListPaths() {
+        try {
+            fix = new Metafix("nothing()");
+            fix.setRepeatedFieldsToEntities(true);
+            fix.setEntityMemberName("*");
+        }
+        catch (final FileNotFoundException e) {
+            e.printStackTrace();
+        }
+    }
+
+    @Override
+    protected void onSetReceiver() {
+        final TripleCount tripleCount = new TripleCount();
+        tripleCount.setCountBy(Compare.PREDICATE);
+        fix
+            .setReceiver(new StreamFlattener())
+            .setReceiver(new StreamToTriples())
+            .setReceiver(tripleCount)
+            .setReceiver(new ObjectTemplate<Triple>("${s}\t ${o}"))
+            .setReceiver(getReceiver());
+    }
+
+    @Override
+    public void startRecord(final String identifier) {
+        fix.startRecord(identifier);
+    }
+
+    @Override
+    public void endRecord() {
+        fix.endRecord();
+    }
+
+    @Override
+    public void startEntity(final String name) {
+        fix.startEntity(name);
+    }
+
+    @Override
+    public void endEntity() {
+        fix.endEntity();
+    }
+
+    @Override
+    public void literal(final String name, final String value) {
+        fix.literal(name, value);
+    }
+
+    @Override
+    protected void onCloseStream() {
+        fix.closeStream();
+    }
+
+    @Override
+    protected void onResetStream() {
+        fix.resetStream();
+    }
+}

metafix/src/main/resources/flux-commands.properties

@@ -13,3 +13,4 @@
 # limitations under the License.
 #
 fix org.metafacture.metafix.Metafix
+fix-list-paths org.metafacture.metafix.MetafixListPaths

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

@@ -0,0 +1,63 @@
+/*
+ * Copyright 2023 Fabian Steeg, hbz
+ *
+ * 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.metafix;
+
+import org.metafacture.framework.ObjectReceiver;
+
+import org.junit.jupiter.api.Test;
+import org.mockito.Mock;
+import org.mockito.Mockito;
+import org.mockito.MockitoAnnotations;
+import org.mockito.exceptions.base.MockitoAssertionError;
+
+/**
+ * Tests for class {@link MetafixListPaths}.
+ *
+ * @author Fabian Steeg
+ *
+ */
+public final class MetafixListPathsTest {
+
+    private MetafixListPaths lister;
+
+    @Mock
+    private ObjectReceiver<String> receiver;
+
+    public MetafixListPathsTest() {
+        MockitoAnnotations.initMocks(this);
+        lister = new MetafixListPaths();
+        lister.setReceiver(receiver);
+    }
+
+    @Test
+    public void testShouldListPaths() {
+        lister.startRecord("");
+        lister.literal("a", "A");
+        lister.literal("a", "B");
+        lister.literal("a", "C");
+        lister.endRecord();
+        lister.closeStream();
+        try {
+            Mockito.verify(receiver).process("a.*\t 3");
+        }
+        catch (final MockitoAssertionError e) {
+            System.out.println(Mockito.mockingDetails(receiver).printInvocations());
+            throw e;
+        }
+    }
+
+}