Fixes

LeanderCS · LeanderCS · commit 656dd0dd7e2f · 2025-03-29T00:19:10.000+01:00
diff --git a/.github/workflows/deploy-docs.yaml b/.github/workflows/deploy-docs.yaml
@@ -16,21 +16,17 @@ jobs:
     environment: github-pages
 
     steps:
-      - name: Checkout Repository
-        uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
-      - name: Setup Python
-        uses: actions/setup-python@v4
+      - uses: actions/setup-python@v4
         with:
           python-version: '3.x'
 
       - name: Install Dependencies
-        run: |
-          pip install sphinx sphinx_rtd_theme
+        run: pip install sphinx sphinx_rtd_theme
 
       - name: Build Documentation
-        run: |
-          sphinx-build -b html docs/ _build
+        run: sphinx-build -b html docs/ _build
 
       - name: Upload artifacts
         uses: actions/upload-pages-artifact@v3
diff --git a/.github/workflows/publish-to-pypi.yaml b/.github/workflows/publish-to-pypi.yaml
@@ -10,12 +10,11 @@ jobs:
 
     steps:
       - name: Checkout code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
-      - name: Set up Python
-        uses: actions/setup-python@v4
+      - uses: actions/setup-python@v4
         with:
-          python-version: 3.9
+          python-version: 3.11
 
       - name: Install build tools
         run: pip install build twine wheel
diff --git a/.github/workflows/test.yaml b/.github/workflows/test.yaml
@@ -1,4 +1,4 @@
-name: Run Tests
+name: Run Tests and Lint
 
 on: [push]
 
@@ -33,30 +33,6 @@ jobs:
             --cache-to=type=local,dest=/tmp/.buildx-cache,mode=max \
             -t flask-inputfilter . --load
 
-#      - name: Save flask-inputfilter image
-#        run: docker save -o flask-inputfilter.tar flask-inputfilter
-#
-#      - name: Upload flask-inputfilter artifact
-#        uses: actions/upload-artifact@v4
-#        with:
-#          name: flask-inputfilter-image
-#          path: flask-inputfilter.tar
-#
-#  test:
-#    runs-on: ubuntu-latest
-#
-#    steps:
-#      - name: Checkout code
-#        uses: actions/checkout@v4
-#
-#      - name: Download flask-inputfilter artifact
-#        uses: actions/download-artifact@v4
-#        with:
-#          name: flask-inputfilter-image
-#
-#      - name: Load flask-inputfilter image
-#        run: docker load -i flask-inputfilter.tar
-
       - name: Run tests in Docker and upload coverage to Coveralls
         env:
           COVERALLS_REPO_TOKEN: ${{ secrets.COVERALLS_REPO_TOKEN }}
diff --git a/.github/workflows/test_env.yaml b/.github/workflows/test_env.yaml
@@ -1,4 +1,4 @@
-name: Run Tests on all environments
+name: Run Tests on py versions
 
 on: [push]
 
@@ -11,8 +11,7 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - name: Checkout code
-        uses: actions/checkout@v4
+      - uses: actions/checkout@v4
 
       - name: Cache Docker layers
         uses: actions/cache@v4
diff --git a/Makefile b/Makefile
@@ -1,20 +1,12 @@
-# Minimal makefile for Sphinx documentation
-#
-
-# You can set these variables from the command line, and also
-# from the environment for the first two.
 SPHINXOPTS    ?=
 SPHINXBUILD   ?= sphinx-build
 SOURCEDIR     = source
 BUILDDIR      = build
 
-# Put it first so that "make" without argument is like "make help".
 help:
 	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
 
 .PHONY: help Makefile
 
-# Catch-all target: route all unknown targets to Sphinx using the new
-# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
 %: Makefile
 	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
diff --git a/flask_inputfilter/Validator/IsIntegerValidator.py b/flask_inputfilter/Validator/IsIntegerValidator.py
@@ -15,5 +15,5 @@ def __init__(self, error_message: Optional[str] = None) -> None:
     def validate(self, value: Any) -> None:
         if not isinstance(value, int):
             raise ValidationError(
-                self.error_message, f"Value '{value}' is not an integer."
+                self.error_message or f"Value '{value}' is not an integer."
             )
diff --git a/make.bat b/make.bat
@@ -2,7 +2,7 @@
 
 pushd %~dp0
 
-REM Command file for Sphinx documentation
+REM
 
 if "%SPHINXBUILD%" == "" (
 	set SPHINXBUILD=sphinx-build
diff --git a/requirements.txt b/requirements.txt
@@ -2,7 +2,7 @@ autoflake
 black
 coverage
 coveralls
-docformatter
+# docformatter
 flake8==4.0.0
 flask==2.1
 isort
diff --git a/scripts/lint b/scripts/lint
@@ -11,5 +11,5 @@ autoflake --in-place --remove-all-unused-imports --ignore-init-module-imports --
 echo 'Running black'
 black .
 
-echo 'Running docformatter'
-docformatter --in-place .
+# echo 'Running docformatter'
+# docformatter --in-place .
diff --git a/setup.py b/setup.py
@@ -3,6 +3,7 @@
 setup(
     name="flask_inputfilter",
     version="0.1.0",
+    license="MIT",
     author="Leander Cain Slotosch",
     author_email="slotosch.leander@outlook.de",
     description="A library to filter and validate input data in "
@@ -19,7 +20,6 @@
         "requests>=2.22.0",
     ],
     classifiers=[
-        "License :: OSI Approved :: MIT License",
         "Operating System :: OS Independent",
         "Programming Language :: Python :: 3.14",
         "Programming Language :: Python :: 3.13",
diff --git a/test/test_input_filter.py b/test/test_input_filter.py
@@ -104,7 +104,7 @@ def test_route(username):
             self.assertEqual(response.status_code, 200)
             self.assertEqual(response.json, {"username": "test_user"})
 
-    def test_unsupported_method(self) -> None:
+    def test_custom_method(self) -> None:
         """
         Test that a method not supported by the InputFilter instance raises
         a TypeError.
@@ -116,19 +116,24 @@ def __init__(self):
 
         app = Flask(__name__)
 
-        @app.route("/test-unsupported", methods=["POST"])
+        @app.route("/test-custom", methods=["GET"])
         @MyInputFilter.validate()
-        def test_unsupported_route():
+        def test_custom_route():
             validated_data = g.validated_data
             return jsonify(validated_data)
 
         with app.test_client() as client:
-            response = client.post("/test-unsupported")
+            response = client.post("/test-custom")
             self.assertEqual(response.status_code, 405)
 
-    @patch.object(InputFilter, "validateData")
-    def test_validation_error_response(self, mock_validateData):
-        mock_validateData.side_effect = ValidationError("Invalid data")
+            response = client.get("/test-custom")
+            self.assertEqual(response.status_code, 200)
+
+    def test_validation_error_response(self):
+        """
+        Tests the behavior of the application when a validation error occurs
+        due to invalid input data.
+        """
 
         class MyInputFilter(InputFilter):
             def __init__(self):
@@ -137,7 +142,9 @@ def __init__(self):
                     name="age",
                     required=False,
                     default=18,
-                    validators=[IsIntegerValidator()],
+                    validators=[
+                        IsIntegerValidator(error_message="Invalid data")
+                    ],
                 )
 
         app = Flask(__name__)
@@ -153,49 +160,11 @@ def test_route():
         self.assertEqual(response.status_code, 400)
         self.assertEqual(response.data.decode(), "Invalid data")
 
-    @patch.object(InputFilter, "validateData")
-    def test_custom_supported_methods(self, mock_validateData):
-        mock_validateData.return_value = {"username": "test_user", "age": 25}
-
-        class MyInputFilter(InputFilter):
-            def __init__(self):
-                super().__init__(methods=["GET"])
-
-                self.add(
-                    name="username",
-                    required=True,
-                )
-                self.add(
-                    name="age",
-                    required=False,
-                    default=18,
-                    validators=[IsIntegerValidator()],
-                )
-
-        app = Flask(__name__)
-
-        @app.route("/test", methods=["GET", "POST"])
-        @MyInputFilter.validate()
-        def test_route():
-            validated_data = g.validated_data
-            return jsonify(validated_data)
-
-        with app.test_client() as client:
-            response = client.get(
-                "/test", query_string={"username": "test_user"}
-            )
-            self.assertEqual(response.status_code, 200)
-            self.assertEqual(
-                response.json, {"username": "test_user", "age": 25}
-            )
-
-            response = client.post("/test", json={"username": "test_user"})
-            self.assertEqual(response.status_code, 405)
-
     def test_optional(self) -> None:
         """
         Test that optional field validation works.
         """
+
         self.inputFilter.add("name", required=True)
 
         self.inputFilter.validateData({"name": "Alice"})
@@ -207,6 +176,7 @@ def test_default(self) -> None:
         """
         Test that default field works.
         """
+
         self.inputFilter.add("available", default=True)
 
         validated_data = self.inputFilter.validateData({})

Original file line number	Diff line number	Diff line change
`@@ -15,5 +15,5 @@ def __init__(self, error_message: Optional[str] = None) -> None:`
`15`	`15`	`def validate(self, value: Any) -> None:`
`16`	`16`	`if not isinstance(value, int):`
`17`	`17`	`raise ValidationError(`
`18`		`- self.error_message, f"Value '{value}' is not an integer."`
	`18`	`+ self.error_message or f"Value '{value}' is not an integer."`
`19`	`19`	`)`