fixed pre_save colors

Author: orronai

lms/lmsdb/bootstrap.py

@@ -253,17 +253,17 @@ def _uuid_migration() -> bool:
     return True
 
 
-def _evaluation_migration() -> bool:
+def _assessment_migration() -> bool:
     Solution = models.Solution
-    _add_not_null_column(Solution, Solution.evaluation)
+    _add_not_null_column(Solution, Solution.assessment)
     return True
 
 
 def main():
     with models.database.connection_context():
         if models.database.table_exists(models.Solution.__name__.lower()):
             _last_status_view_migration()
-            _evaluation_migration()
+            _assessment_migration()
 
         if models.database.table_exists(models.User.__name__.lower()):
             _api_keys_migration()
@@ -275,8 +275,8 @@ def main():
             models.create_basic_roles()
         if models.User.select().count() == 0:
             models.create_demo_users()
-        if models.SolutionEvaluation.select().count() == 0:
-            models.create_basic_evaluations()
+        if models.SolutionAssessment.select().count() == 0:
+            models.create_basic_assessments()
 
     text_fixer.fix_texts()
     import_tests.load_tests_from_path('/app_dir/notebooks-tests')

lms/lmsdb/models.py

@@ -24,7 +24,8 @@
 from lms.lmsdb import database_config
 from lms.models.errors import AlreadyExists
 from lms.utils import hashing
-from lms.utils.consts import COLORS
+from lms.utils.colors import get_hex_color
+from lms.utils.consts import DEFAULT_ACTIVE_COLOR, DEFAULT_COLOR
 from lms.utils.log import log
 
 
@@ -366,32 +367,34 @@ def to_choices(cls: enum.EnumMeta) -> Tuple[Tuple[str, str], ...]:
         return tuple((choice.name, choice.value) for choice in choices)
 
 
-class SolutionEvaluation(BaseModel):
+class SolutionAssessment(BaseModel):
     name = CharField()
     icon = CharField(null=True)
     color = CharField()
     active_color = CharField()
     order = IntegerField(default=0, index=True, unique=True)
 
     @classmethod
-    def get_evaluations(cls):
+    def get_assessments(cls):
         return cls.select().order_by(cls.order)
 
     def __str__(self):
         return self.name
 
 
-@pre_save(sender=SolutionEvaluation)
-def evaluation_on_save_handler(_model_class, instance, created):
+@pre_save(sender=SolutionAssessment)
+def assessment_on_save_handler(_model_class, instance, created):
     """Change colors to hex."""
 
-    is_color_changed = not instance.color.startswith('#')
-    if created or is_color_changed:
-        instance.color = COLORS.get(instance.color, '#0d6efd')
+    try:
+        instance.color = get_hex_color(instance.color)
+    except ValueError:
+        instance.color = DEFAULT_COLOR
 
-    is_active_color_changed = not instance.active_color.startswith('#')
-    if created or is_active_color_changed:
-        instance.active_color = COLORS.get(instance.active_color, '#fff')
+    try:
+        instance.active_color = get_hex_color(instance.active_color)
+    except ValueError:
+        instance.active_color = DEFAULT_ACTIVE_COLOR
 
 
 class Solution(BaseModel):
@@ -418,8 +421,8 @@ class Solution(BaseModel):
         index=True,
     )
     last_time_view = DateTimeField(default=datetime.now, null=True, index=True)
-    evaluation = ForeignKeyField(
-        SolutionEvaluation, backref='solutions', null=True,
+    assessment = ForeignKeyField(
+        SolutionAssessment, backref='solutions', null=True,
     )
 
     @property
@@ -481,14 +484,14 @@ def start_checking(self) -> bool:
 
     def set_state(
         self, new_state: SolutionState,
-        evaluation: Optional[SolutionEvaluation] = None, **kwargs,
+        assessment: Optional[SolutionAssessment] = None, **kwargs,
     ) -> bool:
         # Optional: filter the old state of the object
         # to make sure that no two processes set the state together
         requested_solution = (Solution.id == self.id)
         updates_dict = {Solution.state.name: new_state.name}
-        if evaluation is not None:
-            updates_dict[Solution.evaluation.name] = evaluation
+        if assessment is not None:
+            updates_dict[Solution.assessment.name] = assessment
         changes = Solution.update(
             **updates_dict, **kwargs,
         ).where(requested_solution)
@@ -513,7 +516,7 @@ def of_user(
         solutions = (
             cls
             .select(
-                cls.exercise, cls.id, cls.state, cls.checker, cls.evaluation,
+                cls.exercise, cls.id, cls.state, cls.checker, cls.assessment,
             )
             .where(cls.exercise.in_(db_exercises), cls.solver == user_id)
             .order_by(cls.submission_timestamp.desc())
@@ -526,8 +529,8 @@ def of_user(
                 exercise['comments_num'] = len(solution.staff_comments)
                 if solution.is_checked and solution.checker:
                     exercise['checker'] = solution.checker.fullname
-                if solution.evaluation:
-                    exercise['evaluation'] = solution.evaluation.name
+                if solution.assessment:
+                    exercise['assessment'] = solution.assessment.name
         return tuple(exercises.values())
 
     @property
@@ -630,13 +633,13 @@ def _base_next_unchecked(cls):
 
     def mark_as_checked(
         self,
-        evaluation_id: Optional[int] = None,
+        assessment_id: Optional[int] = None,
         by: Optional[Union[User, int]] = None,
     ) -> bool:
         return self.set_state(
             Solution.STATES.DONE,
-            SolutionEvaluation.get_or_none(
-                SolutionEvaluation.id == evaluation_id,
+            SolutionAssessment.get_or_none(
+                SolutionAssessment.id == assessment_id,
             ),
             checker=by,
         )
@@ -1014,17 +1017,17 @@ def create_basic_roles():
         Role.create(name=role.value)
 
 
-def create_basic_evaluations():
-    evaluations_dict = {
+def create_basic_assessments():
+    assessments_dict = {
         'Excellent': {'color': 'green', 'icon': 'star', 'order': 1},
         'Nice': {'color': 'blue', 'icon': 'check', 'order': 2},
         'Try again': {'color': 'red', 'icon': 'exclamation', 'order': 3},
         'Plagiarism': {
             'color': 'black', 'icon': 'exclamation-triangle', 'order': 4,
         },
     }
-    for name, values in evaluations_dict.items():
-        SolutionEvaluation.create(
+    for name, values in assessments_dict.items():
+        SolutionAssessment.create(
             name=name, icon=values.get('icon'), color=values.get('color'),
             active_color='white', order=values.get('order'),
         )

lms/lmsweb/translations/he/LC_MESSAGES/messages.po

@@ -7,7 +7,7 @@ msgid ""
 msgstr ""
 "Project-Id-Version:  1.0\n"
 "Report-Msgid-Bugs-To: EMAIL@ADDRESS\n"
-"POT-Creation-Date: 2021-10-02 12:46+0300\n"
+"POT-Creation-Date: 2021-10-03 09:13+0300\n"
 "PO-Revision-Date: 2021-09-29 11:30+0300\n"
 "Last-Translator: Or Ronai\n"
 "Language: he\n"
@@ -18,7 +18,7 @@ msgstr ""
 "Content-Transfer-Encoding: 8bit\n"
 "Generated-By: Babel 2.9.1\n"
 
-#: lmsdb/models.py:764
+#: lmsdb/models.py:781
 msgid "Fatal error"
 msgstr "כישלון חמור"
 
@@ -418,7 +418,7 @@ msgid "It's important for us that all exercises will be checked by human eye."
 msgstr "חשוב לנו שכל תרגיל יעבור בדיקה של עין אנושית."
 
 #: templates/view.html:18
-msgid "Presenter"
+msgid "Solver"
 msgstr "מגיש"
 
 #: templates/view.html:24

lms/lmsweb/views.py

@@ -614,11 +614,11 @@ def shared_solution(shared_url: str, file_id: Optional[int] = None):
 @managers_only
 def done_checking(exercise_id, solution_id):
     if request.method == 'POST':
-        evaluation_id = request.json.get('evaluation')
+        assessment_id = request.json.get('assessment')
     else:  # it's a GET
-        evaluation_id = request.args.get('evaluation')
+        assessment_id = request.args.get('assessment')
     is_updated = solutions.mark_as_checked(
-        solution_id, current_user.id, evaluation_id,
+        solution_id, current_user.id, assessment_id,
     )
     next_solution = solutions.get_next_unchecked(exercise_id)
     next_solution_id = getattr(next_solution, 'id', None)

lms/models/solutions.py

@@ -9,7 +9,7 @@
 
 from lms.extractors.base import File
 from lms.lmsdb.models import (
-    SharedSolution, Solution, SolutionEvaluation, SolutionFile, User,
+    SharedSolution, Solution, SolutionAssessment, SolutionFile, User,
 )
 from lms.lmstests.public.general import tasks as general_tasks
 from lms.lmstests.public.identical_tests import tasks as identical_tests_tasks
@@ -66,11 +66,11 @@ def get_message_and_addressee(
 
 
 def mark_as_checked(
-    solution_id: int, checker_id: int, evaluation_id: Optional[int] = None,
+    solution_id: int, checker_id: int, assessment_id: Optional[int] = None,
 ) -> bool:
     checked_solution: Solution = Solution.get_by_id(solution_id)
     is_updated = checked_solution.mark_as_checked(
-        evaluation_id=evaluation_id, by=checker_id,
+        assessment_id=assessment_id, by=checker_id,
     )
     msg = _(
         'Your solution for the "%(subject)s" exercise has been checked.',
@@ -142,7 +142,7 @@ def get_view_parameters(
             'user_comments':
                 comments._common_comments(user_id=current_user.id),
             'left': Solution.left_in_exercise(solution.exercise),
-            'evaluations': SolutionEvaluation.get_evaluations(),
+            'assessments': SolutionAssessment.get_assessments(),
         }
 
     if viewer_is_solver:

lms/static/checker.js

@@ -1,7 +1,7 @@
 function trackFinished(exerciseId, solutionId, element) {
   element.addEventListener('click', () => {
-    const evaluation = document.querySelector('input[name="evaluation"]:checked');
-    const evaluationValue = evaluation.value;
+    const assessment = document.querySelector('input[name="assessment"]:checked');
+    const assessmentValue = assessment.value;
     const xhr = new XMLHttpRequest();
     xhr.open('POST', `/checked/${exerciseId}/${solutionId}`, true);
     xhr.setRequestHeader('Content-Type', 'application/json');
@@ -21,7 +21,7 @@ function trackFinished(exerciseId, solutionId, element) {
     };
 
     xhr.send(JSON.stringify({
-      evaluation: evaluationValue,
+      assessment: assessmentValue,
     }));
   });
 }

lms/static/my.css

@@ -616,7 +616,7 @@ code {
   display: block;
 }
 
-#solution-evaluation {
+#solution-assessment {
   display: flex;
 }
 

lms/templates/user.html

@@ -43,7 +43,7 @@ <h2>{{ _('Exercises Submitted') }}:</h2>
               </td>
               <td><a href="/view/{{ solution.solution_id }}">{{ solution.solution_id }}</a></td>
               <td>{{ solution.get('checker', '') | e }}</a></td>
-              <td>{{ solution.get('evaluation', '') | e }}</td>
+              <td>{{ solution.get('assessment', '') | e }}</td>
             </tr>
             {% endfor -%}
           </tbody>

lms/templates/view.html

@@ -15,10 +15,10 @@ <h1>{{ _('Exercise view') }} {{ solution['exercise']['id'] }}: {{ solution['exer
         <p class="unchecked-msg {{ direction }}"><strong>{{ _("Your solution hasn't been checked.") }}</strong> {{ _("It's important for us that all exercises will be checked by human eye.") }}</p>
       {% endif %}
     {% else %}
-      <p id="solver"><strong>{{ _('Presenter') }}:</strong> <a href="/user/{{ solution['solver']['id'] }}">{{ solution['solver']['fullname'] | e }}</a></p>
+      <p id="solver"><strong>{{ _('Solver') }}:</strong> <a href="/user/{{ solution['solver']['id'] }}">{{ solution['solver']['fullname'] | e }}</a></p>
     {% endif %}
-    {% if solution.evaluation and not shared_url %}
-      <p id="evaluation"><strong>{{ _('Verbal note') }}:</strong>{% if solution.evaluation.icon %} <i class="fa fa-{{ solution.evaluation.icon | e }}"></i>{% endif %} {{ solution.evaluation.name | e }}</p>
+    {% if solution.assessment and not shared_url %}
+      <p id="assessment"><strong>{{ _('Verbal note') }}:</strong>{% if solution.assessment.icon %} <i class="fa fa-{{ solution.assessment.icon | e }}"></i>{% endif %} {{ solution.assessment.name | e }}</p>
     {% endif %}
     {% if not shared_url %}
     <nav id="versions" aria-label="{{ _('Navigate in solution versions') }}">
@@ -100,12 +100,12 @@ <h5 class="test-name">
     </div>
     {% if is_manager and not shared_url %}
     <div id="popular-comments">
-      <div id="exercise-evaluation" class="{{ direction }}">
+      <div id="exercise-assessment" class="{{ direction }}">
         <h2>{{ _('Verbal note') }}</h2>
-        <div class="btn-group-vertical" id="solution-evaluation" role="group" aria-label="evaluations radio toggle button group">
-          {% for evaluation in evaluations %}
-            <input type="radio" class="btn-check" name="evaluation" id="btnradio{{ loop.index }}" autocomplete="off" value="{{ evaluation.id }}" {%- if solution.evaluation.name == evaluation.name or loop.first %}checked{% endif -%}>
-            <label class="btn btn-outline" style="--color: {{ evaluation.color }}; --active-color: {{ evaluation.active_color }};" for="btnradio{{ loop.index }}">{% if evaluation.icon %}<i class="fa fa-{{ evaluation.icon }}"></i> {% endif %}{{ evaluation.name }}</label>
+        <div class="btn-group-vertical" id="solution-assessment" role="group" aria-label="assessments radio toggle button group">
+          {% for assessment in assessments %}
+            <input type="radio" class="btn-check" name="assessment" id="btnradio{{ loop.index }}" autocomplete="off" value="{{ assessment.id }}" {%- if solution.assessment.name == assessment.name or loop.first %}checked{% endif -%}>
+            <label class="btn btn-outline" style="--color: {{ assessment.color }}; --active-color: {{ assessment.active_color }};" for="btnradio{{ loop.index }}">{% if assessment.icon %}<i class="fa fa-{{ assessment.icon }}"></i> {% endif %}{{ assessment.name }}</label>
           {% endfor %}
         </div>
       </div>

lms/utils/colors.py

@@ -0,0 +1,15 @@
+import re
+from typing import Optional
+
+from lms.utils.consts import COLORS
+
+
+HEX_COLOR = re.compile(r'(?P<hex>#[a-f0-9]{6}|#[a-f0-9]{3})')
+
+
+def get_hex_color(number: str) -> Optional[str]:
+    if color := HEX_COLOR.match(number):
+        return color.groupdict()['hex']
+    elif color := COLORS.get(number):
+        return color
+    raise ValueError('This is not a valid hex color')

lms/utils/consts.py

@@ -13,3 +13,5 @@
     'teal': '#20c997', 'orange': '#fd7e14', 'pink': '#d63384',
     'purple': '#6f42c1', 'indigo': '#6610f2', 'light': '#f8f9fa',
 }
+DEFAULT_COLOR = '#0d6efd'  # primary
+DEFAULT_ACTIVE_COLOR = '#fff'  # white

tests/conftest.py

@@ -16,7 +16,7 @@
 
 from lms.lmsdb.models import (
     ALL_MODELS, Comment, CommentText, Exercise, Note, Notification, Role,
-    RoleOptions, SharedSolution, Solution, SolutionEvaluation, User,
+    RoleOptions, SharedSolution, Solution, SolutionAssessment, User,
 )
 from lms.extractors.base import File
 from lms.lmstests.public import celery_app as public_app
@@ -46,17 +46,17 @@ def populate_roles():
 
 
 @pytest.fixture(autouse=True, scope='session')
-def populate_evaluations():
-    evaluations_dict = {
+def populate_assessments():
+    assessments_dict = {
         'Excellent': {'color': 'green', 'icon': 'star', 'order': 1},
         'Nice': {'color': 'blue', 'icon': 'check', 'order': 2},
         'Try again': {'color': 'red', 'icon': 'exclamation', 'order': 3},
         'Plagiarism': {
             'color': 'black', 'icon': 'exclamation-triangle', 'order': 4,
         },
     }
-    for name, values in evaluations_dict.items():
-        SolutionEvaluation.create(
+    for name, values in assessments_dict.items():
+        SolutionAssessment.create(
             name=name, icon=values.get('icon'), color=values.get('color'),
             active_color='white', order=values.get('order'),
         )

tests/test_solutions.py

@@ -561,7 +561,7 @@ def test_done_checking(
         client = conftest.get_logged_user(staff_user.username)
         response = client.post(
             f'/checked/{solution.exercise.id}/{solution.id}',
-            data=json.dumps({'evaluation': 1}),
+            data=json.dumps({'assessment': 1}),
             content_type='application/json',
         )
         assert response.status_code == 200