Merge branch 'release/v0.0.3'

DonMat · DonMat · commit d7747b2816b5 · 2017-12-17T17:33:25.000+01:00
diff --git a/README.md b/README.md
@@ -3,7 +3,7 @@
 [![Build Status](https://travis-ci.org/DonMat/PolishIdentifiersUtils-kotlin.svg?branch=master)](https://travis-ci.org/DonMat/PolishIdentifiersUtils-kotlin)
 
 
-This is simple lightweight library written in Kotlin to manage and validates polish identification numbers like: NIP, PESEL, REGON (9-digit and 14-digit).
+This is simple lightweight library written in Kotlin to validate polish identification numbers like: NIP, PESEL, REGON (9-digit and 14-digit).
 
 ## Purpose of project
 It is easier to maintain validators and other utilities functions as one additional library instead of coppy&pase the same code between projects.
@@ -26,7 +26,7 @@ allprojects {
 Step 2. Add the dependency
 ```gradle
 dependencies {
-        compile 'com.github.DonMat:PolishIdentifiersUtils-kotlin:v0.0.2'
+        compile 'com.github.DonMat:PolishIdentifiersUtils-kotlin:v0.0.3'
 }
 ```
 
@@ -36,11 +36,11 @@ dependencies {
   * getBirthDate()
   * getGender()
 
-- NipUtil
-  * IN PROGRESS
+- NipValidator
+  * isValid()
 
-- RegonUtil
-  * IN PROGRESS
+- RegonValidator
+  * isValid()
 
 License
 -------
diff --git a/polishIdentifiersUtils/src/main/java/pl/utkala/polishidentifiersutils/NipValidator.kt b/polishIdentifiersUtils/src/main/java/pl/utkala/polishidentifiersutils/NipValidator.kt
@@ -0,0 +1,62 @@
+/*
+ * Copyright (C) 2017 Mateusz Utkała
+ *
+ * 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 pl.utkala.polishidentifiersutils
+
+class NipValidator(private val nip: String) {
+
+    private val WEIGHTS = intArrayOf(6, 5, 7, 2, 3, 4, 5, 6, 7)
+    var error: ValidatorError? = null
+    private var valid = false
+
+    fun isValid(): Boolean {
+        return when {
+            valid -> true
+            checkInput() -> validate()
+            else -> false
+        }
+    }
+
+    private fun checkInput(): Boolean {
+        val nipNumbers = trimNotDigits(nip)
+
+        return if (nipNumbers.length != 10) {
+            error = ValidatorError.WRONG_LENGTH
+            false
+        } else if (!nipNumbers.matches(Regex("^\\d{10}$"))) {
+            error = ValidatorError.INVALID_INPUT
+            false
+        } else
+            true
+    }
+
+    private fun validate(): Boolean {
+        val nipNumbers = trimNotDigits(nip)
+        val sum = (0 until nipNumbers.length - 1).sumBy { (nipNumbers[it].toString().toInt() * WEIGHTS[it]) }
+
+        return if (sum % 11 == nipNumbers.last().toString().toInt()) {
+            valid = true
+            true
+        } else {
+            error = ValidatorError.INVALID
+            false
+        }
+    }
+
+    private fun trimNotDigits(input: String): String {
+        return if (input.isBlank()) "" else input.replace(Regex("[PL\\s-]"), "")
+    }
+}
diff --git a/polishIdentifiersUtils/src/main/java/pl/utkala/polishidentifiersutils/PeselUtil.kt b/polishIdentifiersUtils/src/main/java/pl/utkala/polishidentifiersutils/PeselUtil.kt
@@ -19,15 +19,16 @@ package pl.utkala.polishidentifiersutils
 class PeselUtil(private val pesel: String) {
     enum class Gender { MALE, FEMALE }
 
-    private val WEIGHTS = listOf(1, 3, 7, 9, 1, 3, 7, 9, 1, 3, 1)
+    private val WEIGHTS = intArrayOf(1, 3, 7, 9, 1, 3, 7, 9, 1, 3, 1)
     var error: ValidatorError? = null
     private var valid = false
 
     fun isValid(): Boolean {
-        return if (valid || checkInput())
-            validate()
-        else
-            false
+        return when {
+            valid -> true
+            checkInput() -> validate()
+            else -> false
+        }
     }
 
     fun getGender(): Gender? {
@@ -84,8 +85,7 @@ class PeselUtil(private val pesel: String) {
     }
 
     private fun validate(): Boolean {
-        var sum = 0
-        pesel.forEachIndexed { index, value -> sum += (value.toInt() * WEIGHTS[index]) }
+        val sum = (0 until pesel.length).sumBy { pesel[it].toInt() * WEIGHTS[it] }
         return if (sum % 10 == 0) {
             valid = true
             true
diff --git a/polishIdentifiersUtils/src/main/java/pl/utkala/polishidentifiersutils/RegonValidator.kt b/polishIdentifiersUtils/src/main/java/pl/utkala/polishidentifiersutils/RegonValidator.kt
@@ -0,0 +1,77 @@
+/*
+ * Copyright (C) 2017 Mateusz Utkała
+ *
+ * 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 pl.utkala.polishidentifiersutils
+
+class RegonValidator(private val regon: String) {
+
+    var error: ValidatorError? = null
+    private var valid = false
+
+    fun isValid(): Boolean {
+        return when {
+            valid -> true
+            checkInput() -> validate()
+            else -> false
+        }
+    }
+
+    private fun checkInput(): Boolean {
+        val regonNumbers = trimNotDigits(regon)
+
+        return if (regonNumbers.length != 9 && regonNumbers.length != 14) {
+            error = ValidatorError.WRONG_LENGTH
+            false
+        } else if (!regonNumbers.matches(Regex("^\\d{9}$")) && !regonNumbers.matches(Regex("^\\d{14}$"))) {
+            error = ValidatorError.INVALID_INPUT
+            false
+        } else
+            true
+    }
+
+    private fun validate(): Boolean {
+        val regonNumbers = trimNotDigits(regon)
+        return if (regonNumbers.length == 9) validateRegon9(regonNumbers) else validateRegon14(regonNumbers)
+    }
+
+    private fun validateRegon9(regonNumbers: String): Boolean {
+        val weights = intArrayOf(8, 9, 2, 3, 4, 5, 6, 7)
+        val sum = (0 until regonNumbers.length - 1).sumBy { (regonNumbers[it].toString().toInt() * weights[it]) }
+        return if (sum % 11 == regonNumbers.last().toString().toInt()) {
+            valid = true
+            true
+        } else {
+            error = ValidatorError.INVALID
+            false
+        }
+    }
+
+    private fun validateRegon14(regonNumbers: String): Boolean {
+        val weights = intArrayOf(2, 4, 8, 5, 0, 9, 7, 3, 6, 1, 2, 4, 8)
+        val sum = (0 until regonNumbers.length - 1).sumBy { (regonNumbers[it].toString().toInt() * weights[it]) }
+        return if (sum % 11 == regonNumbers.last().toString().toInt()) {
+            valid = true
+            true
+        } else {
+            error = ValidatorError.INVALID
+            false
+        }
+    }
+
+    private fun trimNotDigits(input: String): String {
+        return if (input.isBlank()) "" else input.replace(Regex("[\\s-]"), "")
+    }
+}
diff --git a/polishIdentifiersUtils/src/test/kotlin/pl/utkala/polishidentifiersutils/NipValidatorTest.kt b/polishIdentifiersUtils/src/test/kotlin/pl/utkala/polishidentifiersutils/NipValidatorTest.kt
@@ -0,0 +1,69 @@
+/*
+ * Copyright (C) 2017 Mateusz Utkała
+ *
+ * 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 pl.utkala.polishidentifiersutils
+
+import org.junit.Assert.assertEquals
+import org.junit.Test
+
+
+class NipValidatorTest {
+    @Test
+    fun validNipTest() {
+        var nip = NipValidator("3790494818")
+        assertEquals(nip.isValid(), true)
+        assertEquals(nip.error, null)
+
+        nip = NipValidator("PL 106-00-00-062")
+        assertEquals(nip.isValid(), true)
+        assertEquals(nip.error, null)
+    }
+
+    @Test
+    fun invalidNipTest() {
+        val nip = NipValidator("3790494811")
+        assertEquals(nip.isValid(), false)
+        assertEquals(nip.error, ValidatorError.INVALID)
+    }
+
+    @Test
+    fun emptyNipTest() {
+        val nip = NipValidator("")
+        assertEquals(nip.isValid(), false)
+        assertEquals(nip.error, ValidatorError.WRONG_LENGTH)
+    }
+
+    @Test
+    fun shortNipTest() {
+        val nip = NipValidator("1234")
+        assertEquals(nip.isValid(), false)
+        assertEquals(nip.error, ValidatorError.WRONG_LENGTH)
+    }
+
+    @Test
+    fun longNipTest() {
+        val nip = NipValidator("123412341234")
+        assertEquals(nip.isValid(), false)
+        assertEquals(nip.error, ValidatorError.WRONG_LENGTH)
+    }
+
+    @Test
+    fun invalidInputTest() {
+        val nip = NipValidator("EN 106-00-00-062")
+        assertEquals(nip.isValid(), false)
+        assertEquals(nip.error, ValidatorError.WRONG_LENGTH)
+    }
+}
diff --git a/polishIdentifiersUtils/src/test/kotlin/pl/utkala/polishidentifiersutils/RegonValidatorTest.kt b/polishIdentifiersUtils/src/test/kotlin/pl/utkala/polishidentifiersutils/RegonValidatorTest.kt
@@ -0,0 +1,69 @@
+/*
+ * Copyright (C) 2017 Mateusz Utkała
+ *
+ * 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 pl.utkala.polishidentifiersutils
+
+import org.junit.Assert
+import org.junit.Test
+
+class RegonValidatorTest {
+
+    @Test
+    fun validRegonTest() {
+        var regon = RegonValidator("739941302")
+        Assert.assertEquals(regon.isValid(), true)
+        Assert.assertEquals(regon.error, null)
+
+        regon = RegonValidator("457280735")
+        Assert.assertEquals(regon.isValid(), true)
+        Assert.assertEquals(regon.error, null)
+    }
+
+    @Test
+    fun invalidRegonTest() {
+        val regon = RegonValidator("457280733")
+        Assert.assertEquals(regon.isValid(), false)
+        Assert.assertEquals(regon.error, ValidatorError.INVALID)
+    }
+
+    @Test
+    fun emptyRegonTest() {
+        val regon = RegonValidator("")
+        Assert.assertEquals(regon.isValid(), false)
+        Assert.assertEquals(regon.error, ValidatorError.WRONG_LENGTH)
+    }
+
+    @Test
+    fun shortRegonTest() {
+        val regon = RegonValidator("1234")
+        Assert.assertEquals(regon.isValid(), false)
+        Assert.assertEquals(regon.error, ValidatorError.WRONG_LENGTH)
+    }
+
+    @Test
+    fun longRegonTest() {
+        val regon = RegonValidator("123412341234")
+        Assert.assertEquals(regon.isValid(), false)
+        Assert.assertEquals(regon.error, ValidatorError.WRONG_LENGTH)
+    }
+
+    @Test
+    fun invalidInputTest() {
+        val regon = RegonValidator("PL457280735")
+        Assert.assertEquals(regon.isValid(), false)
+        Assert.assertEquals(regon.error, ValidatorError.WRONG_LENGTH)
+    }
+}
