lupin-danquin 0.0.1.dev7__tar.gz → 0.0.1.dev9__tar.gz

{lupin-danquin-0.0.1.dev7/lupin_danquin.egg-info → lupin-danquin-0.0.1.dev9}/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.1
 Name: lupin-danquin
-Version: 0.0.1.dev7
-Summary: # Documentation extraction
+Version: 0.0.1.dev9
+Summary: Testing - Documentation
 License: MIT License
 Keywords: documentation,testing
 Classifier: Development Status :: 3 - Alpha

lupin-danquin-0.0.1.dev9/lupin_danquin/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.0.1.dev9"

lupin-danquin-0.0.1.dev9/lupin_danquin/core/coding_rules_validator/coging_rules_validator.py

@@ -0,0 +1,34 @@
+from typing import List
+import os
+
+from lupin_danquin.core.application import Application
+from lupin_danquin.core.tools.utils import die, find_usrapp_dir, info, warn
+
+
+class CodingRulesValidator:
+    def __init__(self, application_names: List):
+        self.application_names = application_names
+        self.user_app_dir = find_usrapp_dir()
+
+    def _check_coding_rules(self):
+        """Check coding rules for all applications"""
+        result = []
+        base_program_path = self.user_app_dir + os.sep
+        for application_name in self.application_names:
+            program_path = base_program_path + application_name
+            if not os.path.isdir(program_path):
+                die(msg=f"Application '{application_name}' not found")
+            app = Application(program_path, application_name)
+            info(msg=f"Check coding rules for '{application_name}'")
+            result += app.check_coding_rules()
+        return result
+
+    def validate(self):
+        """Validate coding rules"""
+        result = self._check_coding_rules()
+        if len(result) > 0:
+            info(msg=f"{len(result)} errors found while checking coding rules")
+            for error in result:
+                warn(msg=error)
+        else:
+            info(msg="No error found while checking coding rules")

{lupin-danquin-0.0.1.dev7 → lupin-danquin-0.0.1.dev9}/lupin_danquin/core/tools/utils.py

@@ -6,22 +6,6 @@ import re
 import sys
 
 
-def must_get_string_value_from_env_var(var_name: str):
-    """Get a string value from an environment variable.
-    Args:
-        var_name (str): The name of the environment variable.
-    Returns:
-        str: The value of the environment variable.
-    Logs:
-        Error: If the environment {var_name} variable is not set.
-        sys.exit(1)
-    """
-    if not os.getenv(var_name):
-        logging.error(f"Environment variable {var_name} is not set.")
-        sys.exit(1)
-    return os.getenv(var_name)
-
-
 def configure_logging():
     logging.basicConfig(
         format="%(asctime)s %(levelname)s: %(message)s", level=logging.INFO
@@ -37,6 +21,10 @@ def info(msg: str) -> None:
     logging.info(msg)
 
 
+def warn(msg: str) -> None:
+    logging.warning(msg)
+
+
 def update_version():
     """get version from setup.cfg file and
     update __version__ in lupin_danquin.__init__.py
@@ -76,3 +64,11 @@ def read_file(file_path: str) -> str:
     with codecs.open(file_path, encoding="utf-8") as f:
         result = f.read()
     return result
+
+
+def find_usrapp_dir() -> str:
+    """Find the usrapp directory"""
+    for dirpath, dirnames, filenames in os.walk(os.getcwd()):
+        if "usrapp" in dirnames:
+            return os.path.join(dirpath, "usrapp")
+    die(msg="'usrapp' directory not found")

{lupin-danquin-0.0.1.dev7 → lupin-danquin-0.0.1.dev9}/lupin_danquin/core/val3_doc_generator/val3_doc_generator.py

@@ -13,18 +13,12 @@ from jinja2 import (
 )
 
 from lupin_danquin.core.application import Application
-from lupin_danquin.core.tools.utils import die, info
+from lupin_danquin.core.tools.utils import die, find_usrapp_dir, info
 
 
 class Val3Documentation:
-    USR_APP_DIR = "usrapp"
-
-    def _find_usrapp_dir(self) -> str:
-        """Find the usrapp directory"""
-        for dirpath, dirnames, filenames in os.walk(os.getcwd()):
-            if self.USR_APP_DIR in dirnames:
-                return os.path.join(dirpath, self.USR_APP_DIR)
-        die(msg=f"'{self.USR_APP_DIR}' directory not found")
+    def __init__(self):
+        self.user_app_dir = find_usrapp_dir()
 
     def _get_informations_from_applications(
         self, application_names: List
@@ -32,7 +26,7 @@ class Val3Documentation:
         """Get all informations from applications"""
 
         apps_information = []
-        base_program_path = self._find_usrapp_dir() + os.sep
+        base_program_path = self.user_app_dir + os.sep
         for application_name in application_names:
             program_path = base_program_path + application_name
             if not os.path.isdir(program_path):
@@ -78,8 +72,6 @@ class Val3Documentation:
         except (TemplateError, TemplateRuntimeError) as e:
             die(msg=f"Error rendering Jinja2 template: {e}")
 
-        with codecs.open(
-            "./val3_documentation.md", "w", encoding="utf-8"
-        ) as f:
+        with codecs.open("./val3_documentation.md", "w", encoding="utf-8") as f:
             f.write(content)
         info(msg="val3_documentation.md generated")

{lupin-danquin-0.0.1.dev7 → lupin-danquin-0.0.1.dev9}/lupin_danquin/run.py

@@ -8,8 +8,12 @@ from lupin_danquin.core.tools.utils import (
     convert_application_name_to_list,
     read_file,
 )
+
+from lupin_danquin.core.coding_rules_validator.coging_rules_validator import (
+    CodingRulesValidator,
+)
 from lupin_danquin.core.val3_doc_generator.val3_doc_generator import Val3Documentation
-from lupin_danquin.__init__ import __version__
+from lupin_danquin import __version__
 
 
 load_dotenv()
@@ -25,7 +29,7 @@ def version():
 
 @cli.command()
 def valdocs(
-    application_names: Optional[str] = typer.Argument(
+    application_names: str = typer.Argument(
         ...,
         help="Name of applications to be documented. Ex: 'app1,app2,app3'",
         envvar="VAL3_APPLICATIONS",
@@ -60,6 +64,8 @@ def valdocs(
     """
     configure_logging()
 
+    applications_list = convert_application_name_to_list(application_names)
+
     if not beginning_file_path:
         begining_of_file = ""
     else:
@@ -69,7 +75,25 @@ def valdocs(
     else:
         end_of_file = read_file(end_file_path)
 
-    applications_list = convert_application_name_to_list(application_names)
     Val3Documentation().generate_markdown(
         applications_list, begining_of_file, end_of_file
     )
+
+
+@cli.command()
+def check_coding_rules(
+    application_names: str = typer.Argument(
+        ...,
+        help="Name of applications to be check. Ex: 'app1,app2,app3'",
+        envvar="VAL3_APPLICATIONS",
+    )
+):
+    """
+    Check coding rules
+    """
+    configure_logging()
+
+    applications_list = convert_application_name_to_list(application_names)
+
+    check_coding_rules = CodingRulesValidator(applications_list)
+    check_coding_rules.validate()

{lupin-danquin-0.0.1.dev7 → lupin-danquin-0.0.1.dev9/lupin_danquin.egg-info}/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.1
 Name: lupin-danquin
-Version: 0.0.1.dev7
-Summary: # Documentation extraction
+Version: 0.0.1.dev9
+Summary: Testing - Documentation
 License: MIT License
 Keywords: documentation,testing
 Classifier: Development Status :: 3 - Alpha

{lupin-danquin-0.0.1.dev7 → lupin-danquin-0.0.1.dev9}/lupin_danquin.egg-info/SOURCES.txt

@@ -5,7 +5,6 @@ setup.cfg
 setup.py
 lupin_danquin/__init__.py
 lupin_danquin/__main__.py
-lupin_danquin/check_coding_rules.py
 lupin_danquin/run.py
 lupin_danquin.egg-info/PKG-INFO
 lupin_danquin.egg-info/SOURCES.txt
@@ -24,6 +23,8 @@ lupin_danquin/core/local_variable.py
 lupin_danquin/core/parameter.py
 lupin_danquin/core/program.py
 lupin_danquin/core/rules.py
+lupin_danquin/core/coding_rules_validator/__init__.py
+lupin_danquin/core/coding_rules_validator/coging_rules_validator.py
 lupin_danquin/core/tools/__init__.py
 lupin_danquin/core/tools/utils.py
 lupin_danquin/core/val3_doc_generator/__init__.py

{lupin-danquin-0.0.1.dev7 → lupin-danquin-0.0.1.dev9}/setup.cfg

@@ -1,7 +1,7 @@
 [metadata]
 name = lupin-danquin
-version = 0.0.1.dev7
-description = file: README.md
+version = 0.0.1.dev9
+description = Testing - Documentation
 long_description = Test VAL3 code and generate documentation from it
 keywords = documentation, testing
 license = MIT License

lupin-danquin-0.0.1.dev7/lupin_danquin/__init__.py

@@ -1 +0,0 @@
-__version__ = "0.0.1.dev7"

lupin-danquin-0.0.1.dev7/lupin_danquin/check_coding_rules.py

@@ -1,31 +0,0 @@
-import os
-
-from core.application import Application
-
-
-if __name__ == "__main__":
-    base_program_path = (
-        os.path.abspath(os.path.dirname(__file__) + r"/../../danquin/val3/usrapp/")
-        + "/"
-    )
-    application_names = [
-        "TaskManager",
-    ]
-    result = []
-    for application_name in application_names:
-        program_path = base_program_path + application_name
-        app = Application(program_path, application_name)
-        result += app.check_coding_rules()
-
-    if len(result) > 0:
-        print(f"{len(result)} errors found while checking coding rules:")
-        print()
-        print(
-            """
-        """.join(
-                result
-            )
-        )
-    else:
-        print("No error found while checking coding rules.")
-    exit(len(result))