Added support for poll and survey xblocks

examples/course.html

@@ -105,5 +105,58 @@ <h5>
     </li>
    </ul>
   </section>
+  <h4>
+   Survey
+  </h4>
+  <section data-mu-type="survey">
+   <h5 data-max_submissions="10" data-private_results="true" data-xblock-family="xblock.v1">
+    My Survey
+   </h5>
+   <p>
+    Question 1
+   </p>
+   <p>
+    Question 2
+   </p>
+   <p>
+    Question 3
+   </p>
+   <ul>
+    <li>
+     Answer 1
+    </li>
+    <li>
+     Answer 2
+    </li>
+    <li>
+     Answer 3
+    </li>
+   </ul>
+   <code>
+    This is your feedback text after submitting the survey.
+   </code>
+  </section>
+  <section data-mu-type="survey">
+   <h5 data-max_submissions="10" data-private_results="true" data-xblock-family="xblock.v1">
+    My Poll
+   </h5>
+   <p>
+    Can you see this poll example?
+   </p>
+   <ul>
+    <li>
+     Yes
+    </li>
+    <li>
+     No
+    </li>
+    <li>
+     Maybe
+    </li>
+   </ul>
+   <code>
+    This is your feedback text after submitting the poll.
+   </code>
+  </section>
  </body>
 </html>

examples/course.md

@@ -56,3 +56,37 @@ How many legs does a healthy snake have?
 
 :::
 
+#### Survey
+
+::: {mu-type=survey}
+
+#### My Survey {private_results=true max_submissions=10}
+
+Question 1
+
+Question 2
+
+Question 3
+
+* Answer 1
+* Answer 2
+* Answer 3
+
+`This is your feedback text after submitting the survey.`
+
+:::
+
+::: {mu-type=survey}
+
+#### My Poll {private_results=true max_submissions=10}
+
+Can you see this poll example?
+
+* Yes
+* No
+* Maybe
+
+`This is your feedback text after submitting the poll.`
+
+:::
+

examples/olx/sequential/5e20663dadd1e483ac628951dd582ea8.xml

@@ -3,4 +3,6 @@
  </vertical>
  <vertical url_name="936721dab1ecfa97632df0cfccd801f4">
  </vertical>
+ <vertical url_name="21ab14cf7e8b30af0299c634785a5782">
+ </vertical>
 </sequential>

examples/olx/vertical/21ab14cf7e8b30af0299c634785a5782.xml

@@ -0,0 +1,69 @@
+<vertical display_name="Survey">
+ <survey answers='[
+    [
+        "answer_1",
+        "Answer 1"
+    ],
+    [
+        "answer_2",
+        "Answer 2"
+    ],
+    [
+        "answer_3",
+        "Answer 3"
+    ]
+]' block_name="My Survey" feedback="This is your feedback text after submitting the survey." max_submissions="10" private_results="true" questions='[
+    [
+        "question_1",
+        {
+            "img": "",
+            "img_alt": "",
+            "label": "Question 1"
+        }
+    ],
+    [
+        "question_2",
+        {
+            "img": "",
+            "img_alt": "",
+            "label": "Question 2"
+        }
+    ],
+    [
+        "question_3",
+        {
+            "img": "",
+            "img_alt": "",
+            "label": "Question 3"
+        }
+    ]
+]' url_name="c00c90a1289c6f97a797d7f8a8b2df7e" xblock-family="xblock.v1">
+ </survey>
+ <poll answers='[
+    [
+        "yes",
+        {
+            "img": "",
+            "img_alt": "",
+            "label": "Yes"
+        }
+    ],
+    [
+        "no",
+        {
+            "img": "",
+            "img_alt": "",
+            "label": "No"
+        }
+    ],
+    [
+        "maybe",
+        {
+            "img": "",
+            "img_alt": "",
+            "label": "Maybe"
+        }
+    ]
+]' display_name="My Poll" feedback="This is your feedback text after submitting the poll." max_submissions="10" private_results="true" question="Can you see this poll example?" url_name="3ff7105da79eabe8a9adf96e98a0d6d7" xblock-family="xblock.v1">
+ </poll>
+</vertical>

mu/formats/base/writer.py

@@ -31,3 +31,6 @@ def on_video(self, unit: units.Video) -> None:
 
     def on_rawhtml(self, unit: units.RawHtml) -> None:
         pass
+
+    def on_survey(self, unit: units.Survey) -> None:
+        pass

mu/formats/html/reader.py

@@ -120,6 +120,9 @@ def on_section(self, unit_html: BeautifulSoup) -> t.Iterable[units.Unit]:
         elif unit_type == "ftq":
             # Free text question
             yield from process_ftq(unit_html)
+        elif unit_type == "survey":
+            # Survey questionaire
+            yield from process_survey(unit_html)
         else:
             logger.warning("Unit type is unsupported by HTML reader: %s", unit_type)
 
@@ -231,6 +234,18 @@ def process_ftq(unit_html: BeautifulSoup) -> t.Iterable[units.Unit]:
     yield units.FreeTextQuestion(title=title, question=question, answers=answers)
 
 
+def process_survey(unit_html: BeautifulSoup) -> t.Iterable[units.Unit]:
+    title, questions, answers = get_questions_answers(unit_html)
+    feedback = unit_html.find("code").string.strip() if unit_html.find("code") else ""
+    yield units.Survey(
+        title=title,
+        questions=questions,
+        answers=answers,
+        feedback=feedback,
+        attributes=get_data_attributes(unit_html.find(re.compile("^h[1-6]$"))),
+    )
+
+
 def process_video(unit_html: BeautifulSoup) -> t.Iterable[units.Unit]:
     """
     https://developer.mozilla.org/en-US/docs/Web/HTML/Element/video
@@ -288,6 +303,31 @@ def get_question_answers(unit_html: BeautifulSoup) -> t.Tuple[str, str, t.List[s
     return title, question, answers
 
 
+def get_questions_answers(
+    unit_html: BeautifulSoup,
+) -> t.Tuple[str, t.List[str], t.List[str]]:
+    title = ""
+    if title_html := find_title(unit_html):
+        title = title_html.string
+
+    answers = []
+
+    ul_html = unit_html.find("ul")
+    if ul_html is None:
+        raise MuError(f"Missing <ul> element in multiple choice question: {unit_html}")
+    for li_html in ul_html.find_all("li"):
+        answer = li_html.string.strip()
+        answers.append(answer.strip())
+
+    questions = []
+    for q in unit_html.findAll("p"):
+        if "code" not in [c.name for c in q.children]:
+            questions.append(q.string.strip())
+    if len(questions) < 1:
+        raise MuError(f"Missing <p> element in survey: {unit_html}")
+    return title, questions, answers
+
+
 def find_title(unit_html: BeautifulSoup) -> t.Optional[BeautifulSoup]:
     return unit_html.find(
         [

mu/formats/html/writer.py

@@ -86,6 +86,34 @@ def on_freetextquestion(self, unit: units.FreeTextQuestion) -> None:
 
         self.append_to_body(section_html)
 
+    def on_survey(self, unit: units.Survey) -> None:
+        section_html = Tag(name="section", attrs={TYPE_ATTR: "survey"})
+
+        # Write title
+        section_html.append(self.get_header(unit))
+
+        # Write questions
+        for question in unit.questions:
+            question_html = Tag(name="p")
+            question_html.string = question
+            section_html.append(question_html)
+
+        answers_html = Tag(name="ul")
+
+        # Write answers
+        for answer in unit.answers:
+            answer_html = Tag(name="li")
+            answer_html.string = answer
+            answers_html.append(answer_html)
+        section_html.append(answers_html)
+
+        # Write Feedback
+        feedback_html = Tag(name="code")
+        feedback_html.string = unit.feedback
+        section_html.append(feedback_html)
+
+        self.append_to_body(section_html)
+
     def on_video(self, unit: units.Video) -> None:
         """
         We parse the video sources. If one is youtube, we include a youtube iframe.

mu/formats/olx/reader.py

@@ -126,6 +126,46 @@ def on_video(self, unit_xml: BeautifulSoup) -> t.Iterable[units.Unit]:
             sources=sources,
         )
 
+    def on_poll(self, unit_xml: BeautifulSoup) -> t.Iterable[units.Unit]:
+        import json
+
+        attributes: t.Dict[str, str] = unit_xml.attrs
+        attributes["olx-type"] = unit_xml.name
+        questions: t.List[str] = list()
+        questions.append(attributes.pop("question", ""))
+        try:
+            answers: t.List[str] = json.loads(attributes.pop("answers", "[]"))
+        except:
+            answers = list()
+        feedback: str = attributes.pop("feedback", "")
+        yield units.Survey(
+            questions=questions,
+            answers=answers,
+            feedback=feedback,
+            attributes=attributes,
+        )
+
+    def on_survey(self, unit_xml: BeautifulSoup) -> t.Iterable[units.Unit]:
+        import json
+
+        attributes: t.Dict[str, str] = unit_xml.attrs
+        attributes["olx-type"] = unit_xml.name
+        try:
+            questions: t.List[str] = json.loads(attributes.pop("questions", "[]"))
+        except:
+            questions = list()
+        try:
+            answers: t.List[str] = json.loads(attributes.pop("answers", "[]"))
+        except:
+            answers = list()
+        feedback: str = attributes.pop("feedback", "")
+        yield units.Survey(
+            questions=questions,
+            answers=answers,
+            feedback=feedback,
+            attributes=attributes,
+        )
+
 
 class StringReader(InlineReader):
     """