Move "parsing" of user input to SimilarityMetric

Co-authored-by: Ioannis Panagiotas <[email protected]>

Author: vnickolov

algo/src/main/java/org/neo4j/gds/similarity/knn/KnnNodePropertySpecParser.java

@@ -28,7 +28,6 @@
 import java.util.Collections;
 import java.util.HashMap;
 import java.util.List;
-import java.util.Locale;
 import java.util.Map;
 import java.util.stream.Collectors;
 
@@ -114,7 +113,7 @@ private static List<KnnNodePropertySpec> fromMap(Map<String, String> userInput)
             SimilarityMetric similarityMetric;
             if (value != null) {
                 try {
-                    similarityMetric = SimilarityMetric.valueOf(value.toUpperCase(Locale.ENGLISH));
+                    similarityMetric = SimilarityMetric.parse(value);
                     knnNodeProperties.add(new KnnNodePropertySpec(key, similarityMetric));
                 } catch (IllegalArgumentException ex) {
                     throw new IllegalArgumentException(

algo/src/main/java/org/neo4j/gds/similarity/knn/metrics/SimilarityMetric.java

@@ -22,10 +22,15 @@
 import org.neo4j.gds.api.nodeproperties.ValueType;
 
 import static org.neo4j.gds.utils.StringFormatting.formatWithLocale;
+import static org.neo4j.gds.utils.StringFormatting.toUpperCaseWithLocale;
 
 public enum SimilarityMetric {
     JACCARD, OVERLAP, COSINE, EUCLIDEAN, PEARSON, LONG_PROPERTY_METRIC, DOUBLE_PROPERTY_METRIC, DEFAULT;
 
+    public static SimilarityMetric parse(String value) {
+        return SimilarityMetric.valueOf(toUpperCaseWithLocale(value));
+    }
+
     public static SimilarityMetric defaultMetricForType(ValueType valueType) {
         switch (valueType) {
             case LONG:

algo/src/test/java/org/neo4j/gds/similarity/knn/KnnNodePropertySpecParserTest.java

@@ -21,12 +21,13 @@
 
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.params.ParameterizedTest;
-import org.junit.jupiter.params.provider.ValueSource;
+import org.junit.jupiter.params.provider.Arguments;
+import org.junit.jupiter.params.provider.MethodSource;
 import org.neo4j.gds.similarity.knn.metrics.SimilarityMetric;
 
 import java.util.List;
-import java.util.Locale;
 import java.util.Map;
+import java.util.stream.Stream;
 
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.assertj.core.api.Assertions.assertThatThrownBy;
@@ -107,13 +108,23 @@ void shouldParseMap() {
     }
 
     @ParameterizedTest
-    @ValueSource(strings = {"cosine", "euCLIDean", "jACcaRd", "OVERLAP", "Pearson"})
-    void shouldAcceptMetricsRegardlessOfCase(String metric) {
+    @MethodSource("metrics")
+    void shouldAcceptMetricsRegardlessOfCase(String metric, SimilarityMetric expectedMetricValue) {
         var input = "property";
         assertThat(KnnNodePropertySpecParser.parse(Map.of(input, metric)))
             .singleElement()
-            .extracting(spec -> spec.metric().name())
-            .isEqualTo(metric.toUpperCase(Locale.ENGLISH));
+            .extracting(KnnNodePropertySpec::metric)
+            .isEqualTo(expectedMetricValue);
+    }
+
+    public static Stream<Arguments> metrics() {
+        return Stream.of(
+            Arguments.of("cosine", SimilarityMetric.COSINE),
+            Arguments.of("euCLIDean", SimilarityMetric.EUCLIDEAN),
+            Arguments.of("jACcaRd", SimilarityMetric.JACCARD),
+            Arguments.of("OVERLAP", SimilarityMetric.OVERLAP),
+            Arguments.of("Pearson", SimilarityMetric.PEARSON)
+        );
     }
 
     @Test

algo/src/test/java/org/neo4j/gds/similarity/knn/metrics/SimilarityMetricTest.java

@@ -0,0 +1,48 @@
+/*
+ * Copyright (c) "Neo4j"
+ * Neo4j Sweden AB [http://neo4j.com]
+ *
+ * This file is part of Neo4j.
+ *
+ * Neo4j is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+package org.neo4j.gds.similarity.knn.metrics;
+
+import org.junit.jupiter.params.ParameterizedTest;
+import org.junit.jupiter.params.provider.Arguments;
+import org.junit.jupiter.params.provider.MethodSource;
+
+import java.util.stream.Stream;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+class SimilarityMetricTest {
+
+    @ParameterizedTest
+    @MethodSource("metrics")
+    void parse(String userInput, SimilarityMetric expectedMetric) {
+        assertThat(SimilarityMetric.parse(userInput)).isEqualTo(expectedMetric);
+    }
+
+    public static Stream<Arguments> metrics() {
+        return Stream.of(
+            Arguments.of("JACCARD", SimilarityMetric.JACCARD),
+            Arguments.of("Jaccard", SimilarityMetric.JACCARD),
+            Arguments.of("overlap", SimilarityMetric.OVERLAP),
+            Arguments.of("cosinE", SimilarityMetric.COSINE),
+            Arguments.of("Euclidean", SimilarityMetric.EUCLIDEAN),
+            Arguments.of("pearson", SimilarityMetric.PEARSON)
+        );
+    }
+}