feat: Refactoring of the reverse scored questions code 👽

Author: edersoncorbari

.coveragerc

@@ -1,6 +1,6 @@
 [run]
 branch = True
-omit = setup.py, quiz.py
+omit = setup.py, ipipneo/__init__.py, ipipneo/quiz.py
 
 [report]
 skip_empty = True

README.md

@@ -1,6 +1,6 @@
 <img src="https://raw.githubusercontent.com/neural7/five-factor-e/main/doc/neural7.png" align="right" width="80" height="70"/>
 
-# Five Factor E Library 📦 🇧🇷
+# Five Factor E Library 📦 🌊
 
 ![version 1.5.0][img_version]
 ![python 3.7 | 3.8 | 3.9 | 3.10 | 3.11][python_version]
@@ -163,6 +163,7 @@ An example of the output of the results:
       {
          "Openness":{
             "O":24.29091080263288,
+            "score": "low",
             "traits":[
                {
                   "trait":1,
@@ -228,7 +229,7 @@ $ pip install five-factor-e[quiz]
 Example output with graphics:
 
 <p align="center">
-  <img src="https://raw.githubusercontent.com/neural7/five-factor-e/feature/v1.5.0/doc/sample-light-1.png" alt="Representation of the Big Five"/>
+  <img src="https://raw.githubusercontent.com/neural7/five-factor-e/feature/v1.5.0/doc/sample-light-1.png" alt="Big Five Results" border="1"/>
 </p>
 
 *The complete result is saved in the run folder in json format*.

RELEASES.md

@@ -1,6 +1,13 @@
 <img src="https://raw.githubusercontent.com/neural7/five-factor-e/main/doc/neural7.png" align="right" width="80" height="70"/>
 
-### Releases
+### Releases 🎈
+
+Release **[1.6.0](https://github.com/neural7/five-factor-e/releases/tag/v1.6.0)**:
+
+* Added to the return with the big-five averages: (low, average, high);
+* Refactoring of the reverse scored questions code;
+* Added to the quiz program, the verification of the translation of the questions (120 or 300);
+* Added new topics to PyPI setup.
 
 Release **[1.5.0](https://github.com/neural7/five-factor-e/releases/tag/v1.5.0)**:
 

ipipneo/__init__.py

@@ -1,6 +1,6 @@
 """Import of the classes to be used."""
 
 __name__ = "five-factor-e"
-__version__ = "1.5.0"
+__version__ = "1.6.0"
 
 from ipipneo.ipipneo import IpipNeo

ipipneo/facet.py

@@ -191,3 +191,24 @@ def personality(self, size: int, big5: dict, traits: dict, label: str) -> dict:
             raise BaseException(f"The number of questions setting is wrong: {str(e)}")
 
         return create_big5_dict(label=label, big5=big5, x=X, y=Y) or {}
+
+    def big_five_level(self, big5: dict, label: str) -> dict:
+        """
+        Add the average for each Big-Five.
+
+        Args:
+            - big5: Dictionary of personality Big-Five.
+            - label: Capital letter referring to the Big-Five to be checked the average.
+        """
+        big5_ocean_is_valid(label=label)
+
+        score = big5.get(label, 0)
+
+        if score < FacetLevel.LOW.value:
+            big5["score"] = "low"
+        if score >= FacetLevel.LOW.value and score <= FacetLevel.HIGH.value:
+            big5["score"] = "average"
+        if score > FacetLevel.HIGH.value:
+            big5["score"] = "high"
+
+        return big5

ipipneo/ipipneo.py

@@ -5,7 +5,7 @@
 __copyright__ = "Copyright Neural7 2022, Big 5 Personality Traits"
 __credits__ = ["John A. Johnson", "Dhiru Kholia"]
 __license__ = "MIT"
-__version__ = "1.5.0"
+__version__ = "1.6.0"
 __status__ = "production"
 
 import copy
@@ -88,11 +88,11 @@ def evaluator(self, sex: str, age: int, score: list) -> dict:
                 "age": age,
                 "result": {
                     "personalities": [
-                        {"Openness": O},
-                        {"Conscientiousness": C},
-                        {"Extraversion": E},
-                        {"Agreeableness": A},
-                        {"Neuroticism": N},
+                        {"Openness": self.big_five_level(big5=O, label="O")},
+                        {"Conscientiousness": self.big_five_level(big5=C, label="C")},
+                        {"Extraversion": self.big_five_level(big5=E, label="E")},
+                        {"Agreeableness": self.big_five_level(big5=A, label="A")},
+                        {"Neuroticism": self.big_five_level(big5=N, label="N")},
                     ]
                 },
             },

ipipneo/quiz.py

@@ -77,11 +77,16 @@ def get_select(lang: int, question: int) -> list:
     ]
 
 
-def question_translate() -> list:
-    """Return the available question translations."""
+def question_translate_120() -> list:
+    """Return the available question translations (120)."""
     return ["0. IPIP-NEO Original", "1. EN-US", "2. PT-BR", "3. ES-ES"]
 
 
+def question_translate_300() -> list:
+    """Return the available question translations (300)."""
+    return ["0. IPIP-NEO Original"]
+
+
 def quiz(inventory: int, sex: str, age: int, shuffle: str, lang: int) -> None:
     """
     Inventory / quiz of questions.
@@ -399,7 +404,10 @@ def main() -> None:
     shuffle = str(next(filter(yes_or_no.__contains__, replies)))
 
     print("\n====================================================================")
-    print(*question_translate(), sep="\n")
+    if inventory == 120:
+        print(*question_translate_120(), sep="\n")
+    elif inventory == 300:
+        print(*question_translate_300(), sep="\n")
 
     replies = map(
         input,