[FEATURE] Added extended ruleset for option parsing. This fixes

This fixes #91, fixes #93, Fixes #94, Fixes #98 and fixes #99

Author: Seluj78

42PyChecker.py

@@ -6,6 +6,105 @@
 import argparse
 import platform
 from PyChecker.projects import libft, ft_commandements, other, fillit
+import sys
+
+
+def check_args_rules(parser, args):
+    """
+    --verbose:                  Optionnal, no rules there.
+    --no-gui:                   Enabled by default,
+    --project:                  Required, Has a choice.
+    --path:                     Required.
+
+    --no-author:                Optionnal, no rules here expect 42commandements
+    --no-forbidden-functions:   Optionnal, can only be set when project=fdf|fillit|ft_ls|ft_p|ft_printf|gnl\libft|libftasm|minishell|pushswap
+    --no-makefile:              Optionnal, no rules here expect 42commandements
+    --no-norm:                  Optionnal, no rules here expect 42commandements
+    --no-static:                Optionnal, can only be set when project=libft
+    --no-extra:                 Optionnal, can only be set when project=libft
+    --no-required:              Optionnal, can only be set when project=libft
+    --no-bonus:                 Optionnal, can only be set when project=libft
+    --do-benchmark:             Optionnal, can only be set when project=libft
+    --no-tests:                 Optionnal, can only be set when project is not other.
+    --no-libftest:              Optionnal, can only be set when project=libft
+    --no-maintest:              Optionnal, can only be set when project=libft|gnl|ft_ls
+    --no-moulitest:             Optionnal, can only be set when project=libft|gnl|ft_ls|ft_printf|libftasm
+    --no-fillit-checker:        Optionnal, can only be set when project=fillit
+    --no-libft-unit-test:       Optionnal, can only be set when project=libft
+
+    :param args: the parsed arguments passed to the program
+    """
+
+    # If no project is given the parser sends an error.
+    if args.project is None:
+        parser.error("You need to specify a project.")
+    # If the path of the selected project is empty, the parser prints an error.
+    if args.path == "":
+        parser.error("`--path' needs to be specified in order for 42PyChecker"
+                     " to know where your project is.")
+    if args.path[0] != '/':
+        parser.error("`--path' needs to have an absolute path")
+    # If a test is disabled and the libft project is selected, the parser will
+    # return an error.
+
+    # Here, if the `--no-tests` option is set, all the testing suites will be
+    # disabled, no matter the project.
+    if args.project == "other" and args.no_tests:
+        parser.error("`--no-tests' Can only be applied on projects, not when 'other' is selected.")
+    if args.no_tests:
+        args.no_libftest = True
+        args.no_maintest = True
+        args.no_moulitest = True
+        args.no_libft_unit_test = True
+        args.no_fillit_checker = True
+
+    if args.no_author and args.project == "42commandements":
+        parser.error("`--no-author' Can only be applied on project, but not on 42commandements.")
+
+    forbidden_functions_projects = ['fdf', 'fillit', 'ft_ls', 'ft_p', 'ft_printf', 'gnl', 'get_next_line', 'libft', 'libftasm', 'libft_asm', 'minishell', 'pushswap', 'push_swap']
+    if args.no_forbidden_functions and args.project not in forbidden_functions_projects:
+        parser.error("`--no-forbidden-functions' Cannot be set if project isn't one of " + str(forbidden_functions_projects))
+
+    if args.no_makefile and args.project == "42commandements":
+        parser.error("`--no-makefile' Can only be applied on project, but not on 42commandements.")
+
+    if args.no_norm and args.project == "42commandements":
+        parser.error("`--no-norm' Can only be applied on project, but not on 42commandements.")
+
+    if args.no_static and args.project != "libft":
+        parser.error("`--no-static' Can only be applied project `libft'")
+
+    if args.no_extra and args.project != "libft":
+        parser.error("`--no-extra' Can only be applied project `libft'")
+
+    if args.no_required and args.project != "libft":
+        parser.error("`--no-required' Can only be applied project `libft'")
+
+    if args.no_bonus and args.project != "libft":
+        parser.error("`--no-bonus' Can only be applied project `libft'")
+
+    if args.do_benchmark and args.project != "libft":
+        parser.error("`--do-benchmark' Can only be applied project `libft'")
+
+    if args.no_libftest and args.project != "libft":
+        parser.error("`--no-libftest' can only be applied if libft is selected "
+                     "with `--project'")
+
+    if args.no_maintest and args.project != "libft":
+        parser.error("`--no-maintest' can only be applied if libft is selected "
+                     "with `--project'")
+
+    if args.no_moulitest and args.project != "libft":
+        parser.error("`--no-moulitest' can only be applied if libft is selected"
+                     " with `--project'")
+
+    if args.no_libft_unit_test and args.project != "libft":
+        parser.error("`--no-libft-unit-test' can only be applied if libft is selected"
+                     " with `--project'")
+
+    if args.no_fillit_checker and args.project != "fillit":
+        parser.error("`--no-fillit-checker' can only be applied if fillit is selected"
+                     " with `--project'")
 
 
 def print_header():
@@ -49,12 +148,11 @@ def main():
     parser.add_argument("--show-w", help="Displays the warranty warning from the license.", action="store_true")
     parser.add_argument("--show-c", help="Displays the conditions warning from the license.", action="store_true")
     parser.add_argument("--no-tests", help="Disables all the testing suites for the project.", action="store_true")
-    # @todo: Check what option is given based on the selected project.
     parser.add_argument("--no-required", help="Disables required functions check", action="store_true")
     parser.add_argument("--no-libft-unit-test", help="Disables libft-unit-test", action="store_true")
     parser.add_argument("--do-benchmark", help="Enables libft-unit-test benchmarking", action="store_true")
     parser.add_argument("--no-fillit-checker", help="Disables fillit_checker", action="store_true")
-
+    parser.add_argument("--no-bonus", help="Disables the bonus check for the libft", action="store_true")
     # Calls the parser for the arguments we asked to implement.
     args = parser.parse_args()
 
@@ -70,51 +168,22 @@ def main():
               " ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS"
               " WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME\n"
               " THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.")
-        return
+        sys.exit()
 
     # If the `--show-c` argument is passed, the program will display the License
     # and exit.
     if args.show_c:
         with open(root_path + '/.github/LICENSE.lesser', 'r') as file:
             print(file.read())
-        return
-
-    # Here, if the `--no-tests` option is set, all the testing suites will be
-    # disabled, no matter the project.
-    if args.no_tests:
-        args.no_libftest = True
-        args.no_maintest = True
-        args.no_moulitest = True
-        args.no_libft_unit_test = True
+        sys.exit()
 
-    # If no project is given the parser sends an error.
-    if args.project is None:
-        parser.error("You need to specify a project.")
-    # If the path of the selected project is empty, the parser prints an error.
-    if args.path == "":
-        parser.error("`--path' needs to be specified in order for 42PyChecker"
-                     " to know where your project is.")
-    if args.path[0] != '/':
-        parser.error("`--path' needs to have an absolute path")
-    # If a test is disabled and the libft project is selected, the parser will
-    # return an error.
-    if args.no_libftest and args.project != "libft":
-        parser.error("`--no-libftest' can only be applied if libft is selected "
-                     "with `--project'")
-    if args.no_maintest and args.project != "libft":
-        parser.error("`--no-maintest' can only be applied if libft is selected "
-                     "with `--project'")
-    if args.no_moulitest and args.project != "libft":
-        parser.error("`--no-moulitest' can only be applied if libft is selected"
-                     " with `--project'")
+    check_args_rules(parser, args)
 
     # Here we select the project and start the check based on the argument `--project`
     if args.project == "libft":
         libft.check(root_path, args)
-    # @todo: Handle options for 42commandements: No option can be passed (like --no-norm)
     if args.project == "42commandements":
         ft_commandements.check(args)
-    # @todo: Handle options for other: No option can be passed (like --no-norm)
     if args.project == "other":
         other.check(root_path, args)
     if args.project == "fillit":

PyChecker/projects/libft.py

@@ -69,7 +69,8 @@ def check(root_path: str, args):
         author_results = author.check(args.path)
     if not args.no_required:
         required_results = check_required(args.path, required_functions)
-    has_libft_bonuses, bonus_result = check_bonuses(args.path, bonus_functions)
+    if not args.no_bonus:
+        has_libft_bonuses, bonus_result = check_bonuses(args.path, bonus_functions)
     if not args.no_extra:
         extra_functions = count_extras(args.path, required_functions, bonus_functions)
     if not args.no_norm:
@@ -97,7 +98,8 @@ def check(root_path: str, args):
         print("Author File: \n" + author_results + '\n')
     if not args.no_required:
         print("Required Functions: \n" + required_results + '\n')
-    print("Bonus Functions: \n" + bonus_result + '\n')
+    if not args.no_bonus:
+        print("Bonus Functions: \n" + bonus_result + '\n')
     if not args.no_extra:
         # @todo: Stats on all c/h files of project, like with `cloc' ?
         print("Extra Functions: -- You have {}\n".format(len(extra_functions)))

README.md

@@ -59,13 +59,16 @@ This option has no effect when used without the option `--project`.
 Specify the absolute path of directory of your project.  
 e.g.: `python3 ./42PyChecker.py --project=libft --path=/Users/admin/Projects/libft/`.
 
-##### `--no-author`, `--no-norm`, `--no-makefile`, `--no-forbidden-functions`, `--no-static`, `--no-moulitest`, `--no-maintest`, `--no-libftest`, `--no-extra`
+##### `--no-author`, `--no-norm`, `--no-makefile`, `--no-forbidden-functions`, `--no-static`, `--no-moulitest`, `--no-maintest`, `--no-libftest`, `--no-extra` `--no-required`, `--no-libft-unit-test`, `--no-fillit-checker`, `--no-bonus`
 
 Disable a specific test.
 
 ##### `--no-tests`
 This will disable all testing suites but run the other tests.
 
+##### `--do-benchmark`
+Enables speed benchmark for libft
+
 #### `--show-c` and `--show-w`
 These options will display respectively the License and the Warranty.