garydgregory commented on code in PR #216: URL: https://github.com/apache/commons-validator/pull/216#discussion_r1590003430
########## src/main/java/org/apache/commons/validator/routines/checkdigit/ECNumberCheckDigit.java: ########## @@ -0,0 +1,116 @@ +/* + * 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.validator.routines.checkdigit; + +import org.apache.commons.validator.routines.CodeValidator; + +/** + * Modulus 11 <b>EC number</b> Check Digit calculation/validation. + * + * <p> + * The European Community number (EC number) is a unique seven-digit identifier + * that is assigned to chemical substances. + * For example, the EC number of arsenic is 231-148-6: + * </p> + * + * Check digit calculation is based on <i>modulus 11</i> with digits being weighted + * based on their position (from left to right). + * <p> + * + * <p> + * For further information see + * <a href="https://en.wikipedia.org/wiki/European_Community_number";>Wikipedia - EC number</a>. + * </p> + * + * @since 1.9 Review Comment: Use `1.9.0`. ########## src/main/java/org/apache/commons/validator/routines/checkdigit/ECNumberCheckDigit.java: ########## @@ -0,0 +1,116 @@ +/* + * 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.validator.routines.checkdigit; + +import org.apache.commons.validator.routines.CodeValidator; + +/** + * Modulus 11 <b>EC number</b> Check Digit calculation/validation. + * + * <p> + * The European Community number (EC number) is a unique seven-digit identifier + * that is assigned to chemical substances. + * For example, the EC number of arsenic is 231-148-6: + * </p> + * + * Check digit calculation is based on <i>modulus 11</i> with digits being weighted + * based on their position (from left to right). + * <p> + * + * <p> + * For further information see + * <a href="https://en.wikipedia.org/wiki/European_Community_number";>Wikipedia - EC number</a>. + * </p> + * + * @since 1.9 + */ +public final class ECNumberCheckDigit extends ModulusCheckDigit { + + private static final long serialVersionUID = 7265356024784308367L; + + /** Singleton Check Digit instance */ + public static final CheckDigit EC_CHECK_DIGIT = new ECNumberCheckDigit(); + + /** + * EC number consists of 3 groups of numbers separated dashes (-). + * Example: dexamethasone is 200-003-9 + */ + private static final String GROUP = "(\\d{3})"; + private static final String DASH = "(?:\\-)"; + static final String EC_REGEX = "^(?:" + GROUP + DASH + GROUP + DASH + "(\\d))$"; + + private static final int EC_LEN = 7; + static final CodeValidator REGEX_VALIDATOR = new CodeValidator(EC_REGEX, EC_LEN, null); + + /** + * Constructs a modulus 11 Check Digit routine. + */ + public ECNumberCheckDigit() { + super(MODULUS_11); + } + + /** + * Calculates the <i>weighted</i> value of a character in the + * code at a specified position. + * + * <p>For EC number digits are weighted by their position from left to right.</p> + * + * @param charValue The numeric value of the character. + * @param leftPos The position of the character in the code, counting from left to right + * @param rightPos The positionof the character in the code, counting from right to left + * @return The weighted value of the character. + */ + @Override + protected int weightedValue(final int charValue, final int leftPos, final int rightPos) { + return (leftPos >= EC_LEN) ? 0 : charValue * leftPos; Review Comment: Parens are not needed. ########## src/main/java/org/apache/commons/validator/routines/checkdigit/CASNumberCheckDigit.java: ########## @@ -0,0 +1,129 @@ +/* + * 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.validator.routines.checkdigit; + +import org.apache.commons.validator.routines.CodeValidator; + +/** + * Modulus 10 <b>CAS Registry Number</b> (or <b>Chemical Abstracts Service</b> (CAS RN)) Check Digit + * calculation/validation. + * + * <p> + * CAS Numbers are unique identification numbers used + * to identify chemical substance described in the open scientific literature. + * </p> + * + * Check digit calculation is based on <i>modulus 10</i> with digits being weighted + * based on their position (from right to left). + * + * The check digit is found by taking the last digit times 1, the preceding digit times 2, + * the preceding digit times 3 etc., adding all these up and computing the sum modulo 10. + * For example, the CAS number of water is 7732-18-5: + * the checksum 5 is calculated as (8×1 + 1×2 + 2×3 + 3×4 + 7×5 + 7×6) = 105; 105 mod 10 = 5. + * + * <p> + * For further information see + * <a href="https://en.wikipedia.org/wiki/CAS_Registry_Number";>Wikipedia - CAS Registry Number</a>. + * </p> + * + * @since 1.9 + */ +public final class CASNumberCheckDigit extends ModulusCheckDigit { + + private static final long serialVersionUID = -5387334603220786657L; + + /** Singleton Check Digit instance */ + public static final CheckDigit CAS_CHECK_DIGIT = new CASNumberCheckDigit(); Review Comment: Use `INSTANCE` for the singleton name, make it private and add a `getInstance()` public static method (like `DoubleValidator.getInstance()` and friends.) ########## src/main/java/org/apache/commons/validator/routines/checkdigit/ECNumberCheckDigit.java: ########## @@ -0,0 +1,116 @@ +/* + * 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.validator.routines.checkdigit; + +import org.apache.commons.validator.routines.CodeValidator; + +/** + * Modulus 11 <b>EC number</b> Check Digit calculation/validation. + * + * <p> + * The European Community number (EC number) is a unique seven-digit identifier + * that is assigned to chemical substances. + * For example, the EC number of arsenic is 231-148-6: + * </p> + * + * Check digit calculation is based on <i>modulus 11</i> with digits being weighted + * based on their position (from left to right). + * <p> + * + * <p> + * For further information see + * <a href="https://en.wikipedia.org/wiki/European_Community_number";>Wikipedia - EC number</a>. + * </p> + * + * @since 1.9 + */ +public final class ECNumberCheckDigit extends ModulusCheckDigit { + + private static final long serialVersionUID = 7265356024784308367L; + + /** Singleton Check Digit instance */ + public static final CheckDigit EC_CHECK_DIGIT = new ECNumberCheckDigit(); + + /** + * EC number consists of 3 groups of numbers separated dashes (-). + * Example: dexamethasone is 200-003-9 + */ + private static final String GROUP = "(\\d{3})"; + private static final String DASH = "(?:\\-)"; + static final String EC_REGEX = "^(?:" + GROUP + DASH + GROUP + DASH + "(\\d))$"; + + private static final int EC_LEN = 7; + static final CodeValidator REGEX_VALIDATOR = new CodeValidator(EC_REGEX, EC_LEN, null); + + /** + * Constructs a modulus 11 Check Digit routine. + */ + public ECNumberCheckDigit() { + super(MODULUS_11); + } + + /** + * Calculates the <i>weighted</i> value of a character in the + * code at a specified position. + * + * <p>For EC number digits are weighted by their position from left to right.</p> + * + * @param charValue The numeric value of the character. + * @param leftPos The position of the character in the code, counting from left to right + * @param rightPos The positionof the character in the code, counting from right to left + * @return The weighted value of the character. + */ + @Override + protected int weightedValue(final int charValue, final int leftPos, final int rightPos) { + return (leftPos >= EC_LEN) ? 0 : charValue * leftPos; + } + + /** + * {@inheritDoc} + */ + @Override + public String calculate(final String code) throws CheckDigitException { + if (code == null || code.isEmpty()) { + throw new CheckDigitException("Code is missing"); + } + final int modulusResult = calculateModulus(code, false); + return toCheckDigit(modulusResult); + } + + /** + * {@inheritDoc} + */ + @Override + public boolean isValid(final String code) { + if (code == null || code.isEmpty()) { + return false; + } + Object cde = REGEX_VALIDATOR.validate(code); + if (cde instanceof String) { + try { + final int modulusResult = calculateModulus((String)cde, true); +// System.out.println("modulusResult="+modulusResult + " for code "+code); Review Comment: Remove comment ########## src/main/java/org/apache/commons/validator/routines/checkdigit/ECNumberCheckDigit.java: ########## @@ -0,0 +1,116 @@ +/* + * 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.validator.routines.checkdigit; + +import org.apache.commons.validator.routines.CodeValidator; + +/** + * Modulus 11 <b>EC number</b> Check Digit calculation/validation. + * + * <p> + * The European Community number (EC number) is a unique seven-digit identifier + * that is assigned to chemical substances. + * For example, the EC number of arsenic is 231-148-6: + * </p> + * + * Check digit calculation is based on <i>modulus 11</i> with digits being weighted + * based on their position (from left to right). + * <p> + * + * <p> + * For further information see + * <a href="https://en.wikipedia.org/wiki/European_Community_number";>Wikipedia - EC number</a>. + * </p> + * + * @since 1.9 + */ +public final class ECNumberCheckDigit extends ModulusCheckDigit { + + private static final long serialVersionUID = 7265356024784308367L; + + /** Singleton Check Digit instance */ + public static final CheckDigit EC_CHECK_DIGIT = new ECNumberCheckDigit(); + + /** + * EC number consists of 3 groups of numbers separated dashes (-). + * Example: dexamethasone is 200-003-9 + */ + private static final String GROUP = "(\\d{3})"; + private static final String DASH = "(?:\\-)"; + static final String EC_REGEX = "^(?:" + GROUP + DASH + GROUP + DASH + "(\\d))$"; + + private static final int EC_LEN = 7; + static final CodeValidator REGEX_VALIDATOR = new CodeValidator(EC_REGEX, EC_LEN, null); + + /** + * Constructs a modulus 11 Check Digit routine. + */ + public ECNumberCheckDigit() { + super(MODULUS_11); + } + + /** + * Calculates the <i>weighted</i> value of a character in the + * code at a specified position. + * + * <p>For EC number digits are weighted by their position from left to right.</p> + * + * @param charValue The numeric value of the character. + * @param leftPos The position of the character in the code, counting from left to right + * @param rightPos The positionof the character in the code, counting from right to left + * @return The weighted value of the character. + */ + @Override + protected int weightedValue(final int charValue, final int leftPos, final int rightPos) { + return (leftPos >= EC_LEN) ? 0 : charValue * leftPos; + } + + /** + * {@inheritDoc} + */ + @Override + public String calculate(final String code) throws CheckDigitException { + if (code == null || code.isEmpty()) { + throw new CheckDigitException("Code is missing"); + } + final int modulusResult = calculateModulus(code, false); Review Comment: Inline single use local variable. ########## src/main/java/org/apache/commons/validator/routines/checkdigit/CASNumberCheckDigit.java: ########## @@ -0,0 +1,129 @@ +/* + * 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.validator.routines.checkdigit; + +import org.apache.commons.validator.routines.CodeValidator; + +/** + * Modulus 10 <b>CAS Registry Number</b> (or <b>Chemical Abstracts Service</b> (CAS RN)) Check Digit + * calculation/validation. + * + * <p> + * CAS Numbers are unique identification numbers used + * to identify chemical substance described in the open scientific literature. + * </p> + * Review Comment: This comment is missing paragraph elements. ########## src/test/java/org/apache/commons/validator/routines/checkdigit/CASNumberCheckDigitTest.java: ########## @@ -0,0 +1,54 @@ +/* + * 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.validator.routines.checkdigit; + +import org.junit.jupiter.api.BeforeEach; + +/** + * CAS Number Check Digit Test. Review Comment: Replace with `Tests {@link CASNumberCheckDigit}.` ########## src/main/java/org/apache/commons/validator/routines/checkdigit/CASNumberCheckDigit.java: ########## @@ -0,0 +1,129 @@ +/* + * 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.validator.routines.checkdigit; + +import org.apache.commons.validator.routines.CodeValidator; + +/** + * Modulus 10 <b>CAS Registry Number</b> (or <b>Chemical Abstracts Service</b> (CAS RN)) Check Digit + * calculation/validation. + * + * <p> + * CAS Numbers are unique identification numbers used + * to identify chemical substance described in the open scientific literature. + * </p> + * + * Check digit calculation is based on <i>modulus 10</i> with digits being weighted + * based on their position (from right to left). + * + * The check digit is found by taking the last digit times 1, the preceding digit times 2, + * the preceding digit times 3 etc., adding all these up and computing the sum modulo 10. + * For example, the CAS number of water is 7732-18-5: + * the checksum 5 is calculated as (8×1 + 1×2 + 2×3 + 3×4 + 7×5 + 7×6) = 105; 105 mod 10 = 5. + * + * <p> + * For further information see + * <a href="https://en.wikipedia.org/wiki/CAS_Registry_Number";>Wikipedia - CAS Registry Number</a>. + * </p> + * + * @since 1.9 + */ +public final class CASNumberCheckDigit extends ModulusCheckDigit { + + private static final long serialVersionUID = -5387334603220786657L; + + /** Singleton Check Digit instance */ + public static final CheckDigit CAS_CHECK_DIGIT = new CASNumberCheckDigit(); + + /** + * CAS number consists of 3 groups of numbers separated dashes (-). + * First group up to 7 digits. + * Example: water is 7732-18-5 + */ + private static final String GROUP1 = "(\\d{1,7})"; + private static final String DASH = "(?:\\-)"; + static final String CAS_REGEX = "^(?:" + GROUP1 + DASH + "(\\d{2})" + DASH + "(\\d))$"; + + private static final int CAS_MIN_LEN = 4; // 9-99-9 LEN without SEP + /** maximum capacity of 1,000,000,000 == 9999999-99-9*/ + private static final int CAS_MAX_LEN = 10; + static final CodeValidator REGEX_VALIDATOR = new CodeValidator(CAS_REGEX, CAS_MIN_LEN, CAS_MAX_LEN, null); + + /** Weighting given to digits depending on their right position */ + private static final int[] POSITION_WEIGHT = { 0,1,2,3,4,5,6,7,8,9 }; + + /** + * Constructs a modulus 10 Check Digit routine for CAS Numbers. + */ + public CASNumberCheckDigit() { Review Comment: This can probably be private. ########## src/test/java/org/apache/commons/validator/routines/checkdigit/AbstractCheckDigitTest.java: ########## @@ -154,7 +154,12 @@ public void testCalculateInvalid() { log.debug(" " + i + " Testing Invalid Check Digit, Code=[" + code + "]"); } final String expected = checkDigit(code); - final String actual = routine.calculate(removeCheckDigit(code)); + String codeWithNoCheckDigit = removeCheckDigit(code); + if(codeWithNoCheckDigit==null) { Review Comment: 1. Use spaces around '=='. 2. Rebase on git master to pick up a Checkstyle rule that will check for this. 3. Run `mvn` by itself to check ########## src/main/java/org/apache/commons/validator/routines/checkdigit/ECNumberCheckDigit.java: ########## @@ -0,0 +1,116 @@ +/* + * 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.validator.routines.checkdigit; + +import org.apache.commons.validator.routines.CodeValidator; + +/** + * Modulus 11 <b>EC number</b> Check Digit calculation/validation. + * + * <p> + * The European Community number (EC number) is a unique seven-digit identifier + * that is assigned to chemical substances. + * For example, the EC number of arsenic is 231-148-6: + * </p> + * + * Check digit calculation is based on <i>modulus 11</i> with digits being weighted + * based on their position (from left to right). + * <p> Review Comment: Unbalanced HTML tag. -- 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: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
