You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@commons.apache.org by GitBox <gi...@apache.org> on 2021/07/09 14:16:35 UTC
[GitHub] [commons-csv] garydgregory commented on a change in pull request #114: CSV-264: Added DuplicateHeaderMode for flexibility with header strictness.
garydgregory commented on a change in pull request #114:
URL: https://github.com/apache/commons-csv/pull/114#discussion_r666978587
##########
File path: src/main/java/org/apache/commons/csv/CSVFormat.java
##########
@@ -1439,9 +1455,21 @@ public String format(final Object... values) {
*
* @return whether duplicate header names are allowed
* @since 1.7
+ * @deprecated Use {@link #getDuplicateHeaderMode()}.
*/
+ @Deprecated
public boolean getAllowDuplicateHeaderNames() {
- return allowDuplicateHeaderNames;
+ return duplicateHeaderMode == DuplicateHeaderMode.ALLOW_ALL;
+ }
+
+ /**
+ * Returns how duplicate headers are handled.
Review comment:
"Returns" -> "Gets"
##########
File path: src/main/java/org/apache/commons/csv/CSVFormat.java
##########
@@ -1439,9 +1455,21 @@ public String format(final Object... values) {
*
* @return whether duplicate header names are allowed
* @since 1.7
+ * @deprecated Use {@link #getDuplicateHeaderMode()}.
*/
+ @Deprecated
public boolean getAllowDuplicateHeaderNames() {
- return allowDuplicateHeaderNames;
+ return duplicateHeaderMode == DuplicateHeaderMode.ALLOW_ALL;
+ }
+
+ /**
+ * Returns how duplicate headers are handled.
+ *
+ * @return if duplicate header values are allowed, allowed conditionally, or disallowed.
+ * @since 1.9
Review comment:
"1.9" -> "1.9.0"
##########
File path: src/main/java/org/apache/commons/csv/DuplicateHeaderMode.java
##########
@@ -0,0 +1,43 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You 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.apache.commons.csv;
+
+/**
+ * Determines how duplicate header fields should be handled
+ * if {@link CSVFormat#withHeader(String...)} is not null.
+ *
+ * @since 1.9
+ */
+public enum DuplicateHeaderMode {
+
+ /**
+ * Allows all duplicate headings.
+ */
+ ALLOW_ALL,
+
+ /**
+ * Allows duplicate headings only if they're empty
Review comment:
"headings" -> "headers"
##########
File path: src/test/java/org/apache/commons/csv/issues/JiraCsv264Test.java
##########
@@ -0,0 +1,98 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You 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.apache.commons.csv.issues;
+
+import org.apache.commons.csv.CSVFormat;
+import org.apache.commons.csv.DuplicateHeaderMode;
+import org.junit.jupiter.api.Assertions;
+import org.junit.jupiter.api.Test;
+
+import java.io.IOException;
+import java.io.StringReader;
+
+/**
+ * When {@link CSVFormat#withHeader(String...)} is not null;
+ * duplicate headers with empty strings should not be allowed.
+ *
+ * @see <a href="https://issues.apache.org/jira/projects/CSV/issues/CSV-264?filter=allopenissues">Jira Ticker</a>
Review comment:
Simplify link, use https://issues.apache.org/jira/browse/CSV-264
##########
File path: src/test/java/org/apache/commons/csv/issues/JiraCsv264Test.java
##########
@@ -0,0 +1,98 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You 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.apache.commons.csv.issues;
+
+import org.apache.commons.csv.CSVFormat;
+import org.apache.commons.csv.DuplicateHeaderMode;
+import org.junit.jupiter.api.Assertions;
+import org.junit.jupiter.api.Test;
+
+import java.io.IOException;
+import java.io.StringReader;
+
+/**
+ * When {@link CSVFormat#withHeader(String...)} is not null;
+ * duplicate headers with empty strings should not be allowed.
+ *
+ * @see <a href="https://issues.apache.org/jira/projects/CSV/issues/CSV-264?filter=allopenissues">Jira Ticker</a>
+ */
+public class JiraCsv264Test {
+
+ private static final String CSV_STRING = "\"\",\"B\",\"\"\n" +
+ "\"1\",\"2\",\"3\"\n" +
+ "\"4\",\"5\",\"6\"";
+
+ /**
+ * A CSV file with a random gap in the middle.
+ */
+ private static final String CSV_STRING_GAP = "\"A\",\"B\",\"\",\"\",\"E\"\n" +
+ "\"1\",\"2\",\"\",\"\",\"5\"\n" +
+ "\"6\",\"7\",\"\",\"\",\"10\"";
+
+ @Test
+ public void testJiraCsv264() throws IOException {
+ final CSVFormat csvFormat = CSVFormat.DEFAULT
+ .builder()
+ .setHeader()
+ .setDuplicateHeaderMode(DuplicateHeaderMode.DISALLOW)
+ .setAllowMissingColumnNames(true)
+ .build();
+
+ try (StringReader reader = new StringReader(CSV_STRING)) {
+ try {
+ csvFormat.parse(reader);
+ Assertions.fail("This shouldn't parse the CSV string successfully.");
+ } catch (IllegalArgumentException ex) {
+ // Test is successful!
+ }
+ }
+ }
+
+ @Test
+ public void testJiraCsv264WithGapAllowEmpty() throws IOException {
+ final CSVFormat csvFormat = CSVFormat.DEFAULT
+ .builder()
+ .setHeader()
+ .setDuplicateHeaderMode(DuplicateHeaderMode.ALLOW_EMPTY)
+ .setAllowMissingColumnNames(true)
+ .build();
+
+ try (StringReader reader = new StringReader(CSV_STRING_GAP)) {
+ csvFormat.parse(reader);
+ }
+ }
+
+ @Test
+ public void testJiraCsv264WithGapDisallow() throws IOException {
+ final CSVFormat csvFormat = CSVFormat.DEFAULT
+ .builder()
+ .setHeader()
+ .setDuplicateHeaderMode(DuplicateHeaderMode.DISALLOW)
+ .setAllowMissingColumnNames(true)
+ .build();
+
+ try (StringReader reader = new StringReader(CSV_STRING_GAP)) {
+ try {
+ csvFormat.parse(reader);
+ Assertions.fail("This shouldn't parse the CSV string successfully.");
+ } catch (IllegalArgumentException ex) {
Review comment:
Please use the JUnit API `Assertions.assertThrows(...)`
##########
File path: src/main/java/org/apache/commons/csv/DuplicateHeaderMode.java
##########
@@ -0,0 +1,43 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You 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.apache.commons.csv;
+
+/**
+ * Determines how duplicate header fields should be handled
+ * if {@link CSVFormat#withHeader(String...)} is not null.
+ *
+ * @since 1.9
+ */
+public enum DuplicateHeaderMode {
+
+ /**
+ * Allows all duplicate headings.
+ */
+ ALLOW_ALL,
+
+ /**
+ * Allows duplicate headings only if they're empty
+ * strings or null.
+ */
+ ALLOW_EMPTY,
+
+ /**
+ * Disallows duplicate headings entirely.
Review comment:
"headings" -> "headers"
##########
File path: src/main/java/org/apache/commons/csv/DuplicateHeaderMode.java
##########
@@ -0,0 +1,43 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You 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.apache.commons.csv;
+
+/**
+ * Determines how duplicate header fields should be handled
+ * if {@link CSVFormat#withHeader(String...)} is not null.
+ *
+ * @since 1.9
+ */
+public enum DuplicateHeaderMode {
+
+ /**
+ * Allows all duplicate headings.
Review comment:
"headings" -> "headers"
##########
File path: src/test/java/org/apache/commons/csv/issues/JiraCsv264Test.java
##########
@@ -0,0 +1,98 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You 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.apache.commons.csv.issues;
+
+import org.apache.commons.csv.CSVFormat;
+import org.apache.commons.csv.DuplicateHeaderMode;
+import org.junit.jupiter.api.Assertions;
+import org.junit.jupiter.api.Test;
+
+import java.io.IOException;
+import java.io.StringReader;
+
+/**
+ * When {@link CSVFormat#withHeader(String...)} is not null;
+ * duplicate headers with empty strings should not be allowed.
+ *
+ * @see <a href="https://issues.apache.org/jira/projects/CSV/issues/CSV-264?filter=allopenissues">Jira Ticker</a>
+ */
+public class JiraCsv264Test {
+
+ private static final String CSV_STRING = "\"\",\"B\",\"\"\n" +
+ "\"1\",\"2\",\"3\"\n" +
+ "\"4\",\"5\",\"6\"";
+
+ /**
+ * A CSV file with a random gap in the middle.
+ */
+ private static final String CSV_STRING_GAP = "\"A\",\"B\",\"\",\"\",\"E\"\n" +
+ "\"1\",\"2\",\"\",\"\",\"5\"\n" +
+ "\"6\",\"7\",\"\",\"\",\"10\"";
+
+ @Test
+ public void testJiraCsv264() throws IOException {
+ final CSVFormat csvFormat = CSVFormat.DEFAULT
+ .builder()
+ .setHeader()
+ .setDuplicateHeaderMode(DuplicateHeaderMode.DISALLOW)
+ .setAllowMissingColumnNames(true)
+ .build();
+
+ try (StringReader reader = new StringReader(CSV_STRING)) {
+ try {
+ csvFormat.parse(reader);
+ Assertions.fail("This shouldn't parse the CSV string successfully.");
+ } catch (IllegalArgumentException ex) {
Review comment:
Please use the JUnit API `Assertions.assertThrows(...)`
##########
File path: src/main/java/org/apache/commons/csv/CSVParser.java
##########
@@ -17,8 +17,6 @@
package org.apache.commons.csv;
-import static org.apache.commons.csv.Token.Type.TOKEN;
Review comment:
Leave the order as is, please.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@commons.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org