Refactor code and improve documentation

CHANGELOG.md

@@ -9,6 +9,9 @@ All notable changes to this project will be documented in this file. The format
 ## Second Release Version 1.1.0
 
 -  added new functionality
+   -  Function added to check if a given EAN-13 barcode is valid or not
+   -  Array validation multiple functions added
+
 -  documentation added
 -  code refactored and code quality improved
 -  test cases and test coverage added

sanatio/array_validator.py

@@ -19,5 +19,3 @@ def isContains(self, value, element) -> bool:  # TODO: test cases is pending
         if element in value:
             return True
         return False
-
-

sanatio/base_class.py

@@ -25,4 +25,4 @@ def isvalidBoolean(self, value)-> bool:
             return False
 
         if isinstance(value, bool):
-            return True
+            return True

sanatio/date_validator.py

@@ -2,6 +2,7 @@
 from dateutil.parser import parse
 from dateutil.parser import parse
 
+
 class DateValidator:
     def __init__(self) -> None:
         pass
@@ -59,4 +60,3 @@ def toDate(self, value, format='%Y-%m-%d'):  # need to improve this function
             return date
         else:
             return None
-

sanatio/document_validator.py

@@ -3,6 +3,7 @@
 from sanatio.utils.utils import all_country, regexs
 from sanatio.utils.checksum import checksum_aadhar, checksum_credit_card
 
+
 class DocumentValidator:
     def __init__(self) -> None:
         pass
@@ -53,5 +54,3 @@ def isCreditCard(self, value: str) -> bool:  # checksum not implemented
             if checksum_credit_card(value):
                 return True
         return False
-
-

sanatio/file_validator.py

@@ -158,5 +158,3 @@ def isPerl(self, value) -> bool:  # TODO: test cases is pending
     def isShell(self, value) -> bool:  # TODO: test cases is pending
         """ check if the string is Shell or not """
         pass
-
-

sanatio/main.py

@@ -10,7 +10,7 @@
 
 
 class Validator(StringValidator, DocumentValidator, UsernameValidator, NumberValidator, 
-                DateValidator, EmailValidator, PasswordValidator, OtherValidator):
+                DateValidator, EmailValidator, PasswordValidator, OtherValidator, ArrayValidator):
     """ Validator class for validating the data """
     def __init__(self):
         super().__init__()

sanatio/number_validator.py

@@ -39,4 +39,3 @@ def toInt(self, value):
             value = 0
 
         return value
-

sanatio/other_validator.py

@@ -3,26 +3,16 @@
 
 from sanatio.utils.utils import all_country, regexs
 from sanatio.base_class import BaseValidator
-
+from sanatio.utils.checksum import checksum_ean
 
 class OtherValidator(BaseValidator):
     def __init__(self):
         super().__init__()
 
     def isEAN13(self, value) -> bool:
         """ check if the string is EAN or not """
-        if isinstance(value, int):
-            value = str(value)
-        if not self.isLength(value, 13, 13):
-            return False
-
-        last_digit = int(value[-1])
-        remaining_numbers = value[:-1]
-        total_sum = sum(int(remaining_numbers[i]) * 3 if i % 2 != 0 else \
-            int(remaining_numbers[i]) for i in range(len(remaining_numbers)))
-        unit_digit = 0 if total_sum % 10 == 0 else 10 - (total_sum % 10)
-        if unit_digit == last_digit:
-            return True
+        value = str(value) if isinstance(value, int) else value
+        return self.isLength(value, 13, 13) and checksum_ean(value)
 
     def isHash(self, value) -> bool:
         """ check if the string is hash or not """

sanatio/string_validator.py

@@ -143,4 +143,3 @@ def removeWhiteSpace(self, value):
         """ remove white space from string """
         if self.isvalidString(value):
             return value.replace(" ", "")
-

sanatio/utils/checksum.py

@@ -2,24 +2,21 @@
 sys.path.append('.')
 from sanatio.utils.checksum_algorithms.verhoeff_algorithm import VerhoeffAlgorithm
 from sanatio.utils.checksum_algorithms.luhn_algorithm import LuhnAlgorithm
-
-verhoeff = VerhoeffAlgorithm()
-luhn = LuhnAlgorithm()
+from sanatio.utils.checksum_algorithms.ean_checksum import EANCheckSum
 
 
 def checksum_aadhar(aadhar_number):
     """ validates aadhar number """
-    return verhoeff.verify(aadhar_number)
+    return VerhoeffAlgorithm().verify(aadhar_number)
 
 def checksum_pan(pan_number):
     """ pancard checksum """
     pass
 
 def checksum_credit_card(credit_card_number):
     """ credit card checksum """
-    return luhn.verify(credit_card_number)
-
-
+    return LuhnAlgorithm().verify(credit_card_number)
 
-# res = checksum_credit_card('4578423013769219')
-# print(res)
+def checksum_ean(ean_number):
+    """ ean checksum """
+    return EANCheckSum().is_valid(ean_number)

sanatio/utils/checksum_algorithms/ean_checksum.py

@@ -0,0 +1,21 @@
+class EANCheckSum:
+    def __init__(self):
+        pass
+
+    def checksum_ean13(self, value: str) -> bool:
+        """Calculate the checksum for the EAN code"""
+        last_digit = int(value[-1])
+        remaining_numbers = value[:-1]
+        total_sum = sum(int(remaining_numbers[i]) * 3 if i % 2 != 0 else \
+            int(remaining_numbers[i]) for i in range(len(remaining_numbers)))
+        unit_digit = 0 if total_sum % 10 == 0 else 10 - (total_sum % 10)
+        if unit_digit == last_digit:
+            return True
+
+    def checksum_ean8(self, value: str) -> bool:
+        """Calculate the checksum for the EAN code"""
+        pass
+
+    def is_valid(self, value: str) -> bool:
+        """Check if the EAN code is valid"""
+        return self.checksum_ean13(value) if len(value) == 13 else self.checksum_ean8(value)

sanatio/utils/checksum_algorithms/luhn_algorithm.py

@@ -35,9 +35,7 @@ def __checksum(self, numbers: str) -> int:
     def verify(self, numbers: str) -> bool:
         """Verify a number using Luhn algorithm."""
         if isinstance(numbers, int):
-            number = str(numbers)
+            numbers = str(numbers)
 
         return self.__checksum(numbers)
-
-
 

sanatio/utils/checksum_algorithms/verhoeff_algorithm.py

@@ -49,4 +49,4 @@ def verify(self, numbers):
             number = str(numbers)
 
         numbers = numbers.replace(' ', '')
-        return self.__checksum(numbers)
+        return self.__checksum(numbers)

tests/array_test.py

@@ -0,0 +1,40 @@
+import sys
+import unittest
+sys.path.append('.')
+from sanatio import Validator
+validator = Validator()
+
+
+class ArrayTest(unittest.TestCase):
+    def test_isArray_True(self):
+        self.assertTrue(validator.isArray([]))
+        self.assertTrue(validator.isArray([1, 2, 3]))
+        self.assertTrue(validator.isArray(['a', 'b', 'c']))
+
+    def test_isArray_False(self):
+        self.assertFalse(validator.isArray('abc'))
+        self.assertFalse(validator.isArray(123))
+
+    def test_isLength_True(self):
+        self.assertTrue(validator.isLength([1, 2, 3], 1, 3))
+        self.assertTrue(validator.isLength([1, 2, 3], 3, 3))
+        self.assertTrue(validator.isLength([1, 2, 3], 3, 3))
+
+    def test_isLength_False(self):
+        self.assertFalse(validator.isLength([1, 2, 3], 1, 2))
+        self.assertFalse(validator.isLength([1, 2, 3], 4, 5))
+        self.assertFalse(validator.isLength([1, 2, 3], 1, 2))
+
+    def test_isContains_True(self):
+        self.assertTrue(validator.isContains([1, 2, 3], 1))
+        self.assertTrue(validator.isContains([1, 2, 3], 2))
+        self.assertTrue(validator.isContains([1, 2, 3], 3))
+
+    def test_isContains_False(self):
+        self.assertFalse(validator.isContains([1, 2, 3], 4))
+        self.assertFalse(validator.isContains([1, 2, 3], 5))
+        self.assertFalse(validator.isContains([1, 2, 3], 6))
+
+
+if __name__ == '__main__':
+    unittest.main()

tests/date_test.py

@@ -19,6 +19,8 @@ def test_isDate_true(self):
 
     def test_isDate_false(self):
         self.assertFalse(validator.isDate('2017-01-32'))
+        self.assertFalse(validator.isDate('2017-02-29'))
+        self.assertFalse(validator.isDate('2017-02-30'))
 
     def test_toDate(self):
         self.assertEqual(validator.toDate('2017-01-01'), datetime.datetime(2017, 1, 1, 0, 0))