Merge pull request #30 from datacamp/jh/protowhat-update

Update to latest protowhat

Author: hermansje

pytest.ini

@@ -1,2 +1,2 @@
 [pytest]
-testpaths = tests
+testpaths = tests/

requirements.txt

@@ -1,13 +1,13 @@
 # pkg deps
-protowhat==1.3.0
-attrs==18.2.0
-glom==18.3.1
+protowhat~=1.7.0
+attrs~=18.2.0
+glom~=18.3.1
 
 # test deps
-pytest==3.7.4
-codecov==2.0.15
-pytest-cov==2.5.1
+pytest~=3.7.4
+codecov~=2.0.15
+pytest-cov~=2.5.1
 
 # doc deps
-sphinx==1.7.7
-sphinx_rtd_theme==v0.4.1
+sphinx~=1.7.7
+sphinx_rtd_theme~=0.4.1

setup.py

@@ -18,7 +18,7 @@
     VERSION = str(ast.literal_eval(_version_re.search(fp.read()).group(1)))
 with open(REQUIREMENTS_FILE, encoding="utf-8") as fp:
     req_txt = fp.read()
-    _requirements_re_template = r"^({}(?:\s*[<>=]+\s*\S*)?)\s*(?:#.*)?$"
+    _requirements_re_template = r"^({}(?:\s*[~<>=]+\s*\S*)?)\s*(?:#.*)?$"
     REQUIREMENTS = [
         re.search(_requirements_re_template.format(requirement), req_txt, re.M).group(0)
         for requirement in REQUIREMENT_NAMES

sheetwhat/Reporter.py

@@ -1,38 +1,37 @@
+from protowhat.Feedback import Feedback
 from protowhat.State import State as BaseState
 import copy
 
+from protowhat.Test import Fail
+
+from sheetwhat.selectors import Dispatcher
+
 
 class State(BaseState):
-    def __init__(self, student_data, solution_data, sct_range, reporter):
+    def __init__(
+        self, student_data, solution_data, sct_range, reporter, force_diagnose=False
+    ):
         self.student_data = student_data
         self.solution_data = solution_data
         self.sct_range = sct_range
         self.reporter = reporter
+        self.messages = []
+        self.dispatcher = Dispatcher()
         self.node_name = "root"
-        self.root_message = ""
-
-    def set_root_message(self, message):
-        assert isinstance(message, str)
-        self.root_message = message
+        self.force_diagnose = force_diagnose
 
-    def do_test(self, message_or_issues, *args, **kwargs):
-        is_list = isinstance(message_or_issues, list)
-        is_str = isinstance(message_or_issues, str)
-        assert is_list or is_str
-        if is_list:
-            return self.reporter.do_test(
-                self.root_message, message_or_issues, *args, **kwargs
-            )
-        if is_str:
-            return self.reporter.do_test(message_or_issues)
+    def report(self, feedback: str):
+        return self.do_test(Fail(Feedback(feedback)))
 
-    def to_child(self, student_data, solution_data, node_name=None):
+    def to_child(self, append_message="", node_name=None, **kwargs):
         """Basic implementation of returning a child state"""
         child = copy.deepcopy(self)
-        child.student_data = student_data
-        child.solution_data = solution_data
+        for kwarg in kwargs:
+            setattr(child, kwarg, kwargs[kwarg])
         child.node_name = node_name
-        child.parent = self
+        if not isinstance(append_message, dict):
+            append_message = {"msg": append_message, "kwargs": {}}
+        child.messages = [*self.messages, append_message]
         return child
 
     def to_message_exposed_dict(self):

sheetwhat/State.py

@@ -0,0 +1,136 @@
+import copy
+
+from abc import ABC
+
+from protowhat import selectors
+from protowhat.Test import Test
+from protowhat.Feedback import Feedback
+
+from sheetwhat.utils import is_empty
+
+
+class SolutionBasedTest(Test, ABC):
+    def __init__(self, student_data, solution_data, feedback):
+        super().__init__(feedback)
+        self.student_data = student_data
+        self.solution_data = solution_data
+
+    def __repr__(self):
+        return f"{self.__class__.__name__}:" \
+            f"student data = {self.student_data}" \
+            f"solution data = {self.solution_data}"
+
+
+def array_element_tests(test, student_data, solution_data, feedback, *args, **kwargs):
+    tests = []
+    if not isinstance(student_data, list) or not isinstance(solution_data, list):
+        # If student data is None; Feedback will be provided by a different test.
+        return tests
+    for i, (element_student_data, element_solution_data) in enumerate(
+        zip(student_data, solution_data)
+    ):
+        if isinstance(feedback, str):
+            item_feedback = Feedback(feedback)
+        else:
+            item_feedback = copy.deepcopy(feedback)
+        item_feedback.message = item_feedback.message.format(
+            ordinal=selectors.get_ord(i + 1),
+            expected=element_solution_data,
+            actual=element_student_data,
+        )
+        tests.append(
+            test(
+                element_student_data,
+                element_solution_data,
+                item_feedback,
+                *args,
+                **kwargs,
+            )
+        )
+    return tests
+
+
+class ArrayEqualLengthTest(SolutionBasedTest):
+    def test(self):
+        if (
+            not isinstance(self.student_data, list)
+            or not isinstance(self.solution_data, list)
+            or len(self.solution_data) == 0
+        ):
+            self.result = True
+        else:
+            solution_array_len = len(self.solution_data)
+            student_array_len = len(self.student_data)
+            if solution_array_len != student_array_len:
+                self.result = False
+                self.feedback.message = self.feedback.message.format(
+                    expected=solution_array_len, actual=student_array_len
+                )
+            else:
+                self.result = True
+
+
+class DictKeyEqualityTest(SolutionBasedTest):
+    def test(self):
+        if not isinstance(self.student_data, dict) or not isinstance(
+            self.solution_data, dict
+        ):
+            self.result = True
+        else:
+            solution_key_set = set(self.solution_data.keys())
+            student_key_set = set(self.student_data.keys())
+            if solution_key_set != student_key_set:
+                self.result = False
+                self.feedback.message = self.feedback.message.format(
+                    solution_keys=solution_key_set, student_keys=student_key_set
+                )
+            else:
+                self.result = True
+
+
+class EqualityTest(SolutionBasedTest):
+    def __init__(
+        self, student_data, solution_data, feedback, equal_func=lambda x, y: x == y
+    ):
+        super().__init__(student_data, solution_data, feedback)
+        self.equal_func = equal_func
+
+    def test(self):
+        if self.equal_func(self.student_data, self.solution_data):
+            self.result = True
+        else:
+            self.result = False
+            self.feedback.message = self.feedback.message.format(
+                expected=self.solution_data, actual=self.student_data
+            )
+
+
+class ExistenceTest(SolutionBasedTest):
+    def test(self):
+        if not is_empty(self.solution_data) and is_empty(self.student_data):
+            self.result = False
+        else:
+            self.result = True
+
+
+class OverExistenceTest(SolutionBasedTest):
+    def test(self):
+        if is_empty(self.solution_data) and not is_empty(self.student_data):
+            self.result = False
+        else:
+            self.result = True
+
+
+class SetEqualityTest(SolutionBasedTest):
+    def test(self):
+        if not isinstance(self.student_data, list) or not isinstance(
+            self.solution_data, list
+        ):
+            self.result = True
+        else:
+            solution_set = set(self.solution_data)
+            student_set = set(self.student_data)
+            if solution_set != student_set:
+                self.result = False
+            else:
+                self.result = True

sheetwhat/Test.py

@@ -1,2 +1 @@
 __version__ = "0.4.0"
-

sheetwhat/__init__.py

@@ -27,3 +27,4 @@
 # - no check_file related functionality
 from protowhat.checks.check_logic import fail, multi, check_not, check_or, check_correct
 from protowhat.checks.check_simple import has_chosen, success_msg
+from protowhat.utils import _debug