Penalty system

README.md

@@ -104,6 +104,7 @@ Argument | Description
 **‑s**, **‑‑start-line**|  the first line to be analyzed. By default it starts from `1`.
 **‑e**, **‑‑end-line**  |  the end line to be analyzed. The default value is `None`, which meant to handle file by the end.
 **‑‑new-format**              |  the argument determines whether the tool should use the _new format_. _New format_ means separating the result by the files to allow getting quality and observed issues for each file separately. The default value is `False`.
+**‑‑history**                 |  JSON string with a list of issues for each language. For each issue its class and quantity are specified. Example: `--history "{\"python\": [{\"origin_class\": \"SC200\", \"number\": 20}, {\"origin_class\": \"WPS314\", \"number\": 3}]}"`
 
 The output examples:
 
@@ -124,7 +125,8 @@ The output examples:
       "line": "<the code line>",
       "line_number": 54,
       "column_number": 0,
-      "category": "FUNC_LEN"
+      "category": "FUNC_LEN",
+      "influence_on_penalty": 0 
     },
     ...
   ]
@@ -153,7 +155,8 @@ The output examples:
           "line": "<the code line>",
           "line_number": 174,
           "column_number": 12,
-          "category": "BEST_PRACTICES"
+          "category": "BEST_PRACTICES", 
+          "influence_on_penalty": 0 
         },
         ...
       ]

src/python/common/tool_arguments.py

@@ -72,3 +72,7 @@ class RunToolArgument(Enum):
     NEW_FORMAT = ArgumentsInfo(None, '--new-format',
                                'The argument determines whether the tool '
                                'should use the new format')
+
+    HISTORY = ArgumentsInfo(None, '--history',
+                            'Json string, which contains lists of issues in the previous submissions '
+                            'for other tasks for one user.')

src/python/evaluation/xlsx_run_tool.py

@@ -20,7 +20,7 @@
 )
 from src.python.evaluation.evaluation_config import EvaluationConfig
 from src.python.review.application_config import LanguageVersion
-from src.python.review.common.file_system import create_file, new_temp_dir
+from src.python.review.common.file_system import create_file
 from src.python.review.common.subprocess_runner import run_in_subprocess
 from src.python.review.reviewers.perform_review import OutputFormat
 
@@ -72,6 +72,15 @@ def configure_arguments(parser: argparse.ArgumentParser, run_tool_arguments: Typ
                              'is enabled argument will not be used otherwise.')
 
 
+def get_language(lang_key: str) -> LanguageVersion:
+    try:
+        return LanguageVersion(lang_key)
+    except ValueError as e:
+        logger.error(script_structure_rule)
+        # We should raise KeyError since it is incorrect value for key in a column
+        raise KeyError(e)
+
+
 def create_dataframe(config: EvaluationConfig) -> pd.DataFrame:
     report = pd.DataFrame(
         {
@@ -95,35 +104,29 @@ def create_dataframe(config: EvaluationConfig) -> pd.DataFrame:
         for lang, code in zip(lang_code_dataframe[ColumnName.LANG.value],
                               lang_code_dataframe[ColumnName.CODE.value]):
 
-            with new_temp_dir() as create_temp_dir:
-                temp_dir_path = create_temp_dir
-                lang_extension = LanguageVersion.language_by_extension(lang)
-                temp_file_path = os.path.join(temp_dir_path, ('file' + lang_extension))
-                temp_file_path = next(create_file(temp_file_path, code))
-
-                try:
-                    assert os.path.exists(temp_file_path)
-                except AssertionError as e:
-                    logger.exception('Path does not exist.')
-                    raise e
-
-                command = config.build_command(temp_file_path, lang)
-                results = run_in_subprocess(command)
-                os.remove(temp_file_path)
-                temp_dir_path.rmdir()
-                # this regular expression matches final tool grade: EXCELLENT, GOOD, MODERATE or BAD
-                grades = re.match(r'^.*{"code":\s"([A-Z]+)"', results).group(1)
-                output_row_values = [lang, code, grades]
-                column_indices = [ColumnName.LANGUAGE.value,
-                                  ColumnName.CODE.value,
-                                  ColumnName.GRADE.value]
-
-                if config.traceback:
-                    output_row_values.append(results)
-                    column_indices.append(EvaluationArgument.TRACEBACK.value)
-
-                new_file_report_row = pd.Series(data=output_row_values, index=column_indices)
-                report = report.append(new_file_report_row, ignore_index=True)
+            # Tool does not work correctly with tmp files from <tempfile> module on macOS
+            # thus we create a real file in the file system
+            extension = get_language(lang).extension_by_language().value
+            tmp_file_path = config.xlsx_file_path.parent.absolute() / f'inspected_code{extension}'
+            temp_file = next(create_file(tmp_file_path, code))
+
+            command = config.build_command(temp_file, lang)
+            results = run_in_subprocess(command)
+            os.remove(temp_file)
+
+            # this regular expression matches final tool grade: EXCELLENT, GOOD, MODERATE or BAD
+            grades = re.match(r'^.*{"code":\s"([A-Z]+)"', results).group(1)
+            output_row_values = [lang, code, grades]
+            column_indices = [ColumnName.LANGUAGE.value,
+                              ColumnName.CODE.value,
+                              ColumnName.GRADE.value]
+
+            if config.traceback:
+                output_row_values.append(results)
+                column_indices.append(EvaluationArgument.TRACEBACK.value)
+
+            new_file_report_row = pd.Series(data=output_row_values, index=column_indices)
+            report = report.append(new_file_report_row, ignore_index=True)
 
         return report
 

src/python/review/application_config.py

@@ -1,6 +1,6 @@
 from dataclasses import dataclass
 from enum import Enum, unique
-from typing import List, Optional, Set
+from typing import Dict, List, Optional, Set
 
 from src.python.review.common.file_system import Extension
 from src.python.review.inspectors.inspector_type import InspectorType
@@ -15,6 +15,7 @@ class ApplicationConfig:
     start_line: int = 1
     end_line: Optional[int] = None
     new_format: bool = False
+    history: Optional[str] = None
 
 
 @unique
@@ -31,14 +32,13 @@ def values(cls) -> List[str]:
         return [member.value for member in cls.__members__.values()]
 
     @classmethod
-    def language_to_extension_dict(cls) -> dict:
-        return {cls.PYTHON_3.value: Extension.PY.value,
-                cls.JAVA_7.value: Extension.JAVA.value,
-                cls.JAVA_8.value: Extension.JAVA.value,
-                cls.JAVA_9.value: Extension.JAVA.value,
-                cls.JAVA_11.value: Extension.JAVA.value,
-                cls.KOTLIN.value: Extension.KT.value}
-
-    @classmethod
-    def language_by_extension(cls, lang: str) -> str:
-        return cls.language_to_extension_dict()[lang]
+    def language_to_extension_dict(cls) -> Dict['LanguageVersion', Extension]:
+        return {cls.PYTHON_3: Extension.PY,
+                cls.JAVA_7: Extension.JAVA,
+                cls.JAVA_8: Extension.JAVA,
+                cls.JAVA_9: Extension.JAVA,
+                cls.JAVA_11: Extension.JAVA,
+                cls.KOTLIN: Extension.KT}
+
+    def extension_by_language(self) -> Extension:
+        return self.language_to_extension_dict()[self]

src/python/review/common/file_system.py

@@ -4,7 +4,7 @@
 from contextlib import contextmanager
 from enum import Enum, unique
 from pathlib import Path
-from typing import Callable, List, Union
+from typing import Callable, List, Tuple, Union
 
 
 @unique
@@ -61,6 +61,10 @@ def new_temp_dir() -> Path:
         yield Path(temp_dir)
 
 
+def new_temp_file(suffix: Extension = Extension.EMPTY) -> Tuple[str, str]:
+    yield tempfile.mkstemp(suffix=suffix.value)
+
+
 # File should contain the full path and its extension.
 # Create all parents if necessary
 def create_file(file_path: Union[str, Path], content: str):

src/python/review/quality/model.py

@@ -15,15 +15,18 @@ class QualityType(Enum):
     GOOD = 'GOOD'
     EXCELLENT = 'EXCELLENT'
 
-    def __le__(self, other: 'QualityType') -> bool:
-        order = {
+    def to_number(self) -> int:
+        type_to_number = {
             QualityType.BAD: 0,
             QualityType.MODERATE: 1,
             QualityType.GOOD: 2,
             QualityType.EXCELLENT: 3,
         }
 
-        return order[self] < order[other]
+        return type_to_number.get(self, 3)
+
+    def __le__(self, other: 'QualityType') -> bool:
+        return self.to_number() < other.to_number()
 
 
 class Rule(abc.ABC):