Add google analytics

Author: LeanderCS

docs/_static/google-analytics.js

@@ -0,0 +1,4 @@
+window.dataLayer = window.dataLayer || [];
+function gtag(){dataLayer.push(arguments);}
+gtag('js', new Date());
+gtag('config', 'G-778965FXHK');

docs/conf.py

@@ -11,4 +11,12 @@
 html_theme = "sphinx_rtd_theme"
 html_static_path = ["_static"]
 html_css_files = ["style.css"]
+html_js_files = [
+    (
+        "https://www.googletagmanager.com/gtag/js?id=G-778965FXHK",
+        {"async": "async"},
+    ),
+    ("google-analytics.js", {}),
+]
+html_extra_path = ["_static/google-analytics.js"]
 html_theme_options = {"navigation_depth": 4}

docs/options/special_validator.rst

@@ -0,0 +1,67 @@
+Special Validator
+=================
+
+Special validators are validators that are used to combine or mutate the normal validators.
+They are used to create complex validation logic by combining multiple validators or inverting the result of a validator.
+
+Overview
+--------
+
+
+Example
+
+
+.. code-block:: python
+
+    from flask_inputfilter import InputFilter
+    from flask_inputfilter.Validator import NotValidator, IsIntegerValidator
+
+    class NotIntegerInputFilter(InputFilter):
+        def __init__(self):
+            super().__init__()
+            self.add('value', validators=[
+                NotValidator(validator=IsIntegerValidator())
+            ])
+
+Available Special Validators
+----------------------------
+
+The following special validators are available:
+
+- `AndValidator`_
+- `IfValidator`_
+- `NotValidator`_
+- `OrValidator`_
+- `XorValidator`_
+
+Detailed Description
+--------------------
+
+NotValidator
+~~~~~~~~~~~~
+**Description:**
+
+Inverts the result of another validator. The validation passes if the inner validator fails, and vice versa.
+
+**Parameters:**
+
+- **validator** (*BaseValidator*): The validator whose outcome is to be inverted.
+- **error_message** (*Optional[str]*): Custom error message if the inverted validation does not behave as expected.
+
+**Expected Behavior:**
+
+Executes the inner validator on the input. If the inner validator does not raise a ``ValidationError``, then the NotValidator raises one instead.
+
+**Example Usage:**
+
+.. code-block:: python
+
+    from flask_inputfilter import InputFilter
+    from flask_inputfilter.Validator import NotValidator, IsIntegerValidator
+
+    class NotIntegerInputFilter(InputFilter):
+        def __init__(self):
+            super().__init__()
+            self.add('value', validators=[
+                NotValidator(validator=IsIntegerValidator())
+            ])

flask_inputfilter/Validator/IsHtmlValidator.py

@@ -0,0 +1,23 @@
+import re
+from typing import Any, Optional
+
+from flask_inputfilter.Exception import ValidationError
+from flask_inputfilter.Validator import BaseValidator
+
+
+class IsHtmlValidator(BaseValidator):
+    """
+    Validator that checks if a value contains valid HTML.
+    """
+
+    def __init__(self, error_message: Optional[str] = None) -> None:
+        self.error_message = (
+            error_message or "Value does not contain valid HTML."
+        )
+
+    def validate(self, value: Any) -> None:
+        if not isinstance(value, str):
+            raise ValidationError("Value must be a string.")
+
+        if not re.search(r"<\s*\w+.*?>", value):
+            raise ValidationError(self.error_message)

flask_inputfilter/Validator/IsLowercaseValidator.py

@@ -0,0 +1,21 @@
+from typing import Any, Optional
+
+from flask_inputfilter.Exception import ValidationError
+from flask_inputfilter.Validator import BaseValidator
+
+
+class IsLowercaseValidator(BaseValidator):
+    """
+    Validator that checks if a value is entirely lowercase.
+    """
+
+    def __init__(self, error_message: Optional[str] = None) -> None:
+        self.error_message = (
+            error_message or "Value is not entirely lowercase."
+        )
+
+    def validate(self, value: Any) -> None:
+        if not isinstance(value, str):
+            raise ValidationError("Value must be a string.")
+        if not value.islower():
+            raise ValidationError(self.error_message)

flask_inputfilter/Validator/IsMacAddressValidator.py

@@ -0,0 +1,26 @@
+import re
+from typing import Any, Optional
+
+from flask_inputfilter.Enum import RegexEnum
+from flask_inputfilter.Exception import ValidationError
+from flask_inputfilter.Validator import BaseValidator
+
+MAC_ADDRESS_PATTERN = re.compile(RegexEnum.MAC_ADDRESS.value)
+
+
+class IsMacAddressValidator(BaseValidator):
+    """
+    Validator that checks if a value is a valid MAC address.
+    """
+
+    def __init__(self, error_message: Optional[str] = None) -> None:
+        self.error_message = (
+            error_message or "Value is not a valid MAC address."
+        )
+
+    def validate(self, value: Any) -> None:
+        if not isinstance(value, str):
+            raise ValidationError("Value must be a string.")
+
+        if not MAC_ADDRESS_PATTERN.match(value):
+            raise ValidationError(self.error_message)

flask_inputfilter/Validator/IsMimeTypeValidator.py

@@ -0,0 +1,24 @@
+import re
+from typing import Any, Optional
+
+from flask_inputfilter.Enum import RegexEnum
+from flask_inputfilter.Exception import ValidationError
+from flask_inputfilter.Validator import BaseValidator
+
+MIME_TYPE_PATTERN = re.compile(RegexEnum.MIME_TYPE.value, re.IGNORECASE)
+
+
+class IsMimeTypeValidator(BaseValidator):
+    """
+    Validator that checks if a value is a valid MIME type.
+    """
+
+    def __init__(self, error_message: Optional[str] = None) -> None:
+        self.error_message = error_message or "Value is not a valid MIME type."
+
+    def validate(self, value: Any) -> None:
+        if not isinstance(value, str):
+            raise ValidationError("Value must be a string.")
+
+        if not MIME_TYPE_PATTERN.match(value):
+            raise ValidationError(self.error_message)

flask_inputfilter/Validator/IsPortValidator.py

@@ -0,0 +1,22 @@
+from typing import Any, Optional
+
+from flask_inputfilter.Exception import ValidationError
+from flask_inputfilter.Validator import BaseValidator
+
+
+class IsPortValidator(BaseValidator):
+    """
+    Validator that checks if a value is a valid network port (1-65535).
+    """
+
+    def __init__(self, error_message: Optional[str] = None) -> None:
+        self.error_message = (
+            error_message or "Value is not a valid port number."
+        )
+
+    def validate(self, value: Any) -> None:
+        if not isinstance(value, int):
+            raise ValidationError("Value must be an integer.")
+
+        if not (1 <= value <= 65535):
+            raise ValidationError(self.error_message)

flask_inputfilter/Validator/IsRgbColorValidator.py

@@ -0,0 +1,30 @@
+import re
+from typing import Any, Optional
+
+from flask_inputfilter.Enum import RegexEnum
+from flask_inputfilter.Exception import ValidationError
+from flask_inputfilter.Validator import BaseValidator
+
+RGB_COLOR_PATTERN = re.compile(RegexEnum.RGB_COLOR.value)
+
+
+class IsRgbColorValidator(BaseValidator):
+    """
+    Validator that checks if a value is a valid RGB color string (e.g., 'rgb(255, 0, 0)').
+    """
+
+    def __init__(self, error_message: Optional[str] = None) -> None:
+        self.error_message = error_message or "Value is not a valid RGB color."
+
+    def validate(self, value: Any) -> None:
+        if not isinstance(value, str):
+            raise ValidationError("Value must be a string.")
+
+        match = RGB_COLOR_PATTERN.match(value)
+
+        if not match:
+            raise ValidationError(self.error_message)
+
+        r, g, b = map(int, match.groups())
+        if not (0 <= r <= 255 and 0 <= g <= 255 and 0 <= b <= 255):
+            raise ValidationError(self.error_message)

flask_inputfilter/Validator/IsUppercaseValidator.py

@@ -0,0 +1,22 @@
+from typing import Any, Optional
+
+from flask_inputfilter.Exception import ValidationError
+from flask_inputfilter.Validator import BaseValidator
+
+
+class IsUppercaseValidator(BaseValidator):
+    """
+    Validator that checks if a value is entirely uppercase.
+    """
+
+    def __init__(self, error_message: Optional[str] = None) -> None:
+        self.error_message = (
+            error_message or "Value is not entirely uppercase."
+        )
+
+    def validate(self, value: Any) -> None:
+        if not isinstance(value, str):
+            raise ValidationError("Value must be a string.")
+
+        if not value.isupper():
+            raise ValidationError(self.error_message)