sugar - Add answer test summary options

EJMFarrow · EJMFarrow · commit 89a259481a58 · 2025-07-09T13:33:36.000+01:00
diff --git a/classes/yaml_converter.php b/classes/yaml_converter.php
@@ -297,10 +297,15 @@ public static function loadyaml($yaml, $defaults) {
         return $xmldata;
     }
 
+    /**
+     * Splits an answertest string into its components and adds the fields to the node.
+     * @param mixed $node
+     * @return void
+     */
     public static function parse_answertest(&$node) {
         if (substr($node->answertest, 0, 2) === 'AT') {
             [$answertest, $sans, $tans, $testoptions] = self::split_answertest($node->answertest);
-            self::set_field($node, 'answertest', $answertest);
+            self::set_field($node, 'answertest', substr($answertest, 2));
             self::set_field($node, 'sans', $sans);
             self::set_field($node, 'tans', $tans);
             self::set_field($node, 'testoptions', $testoptions);
@@ -555,10 +560,11 @@ public static function detect_differences($xml, $defaults) {
                             'AT' . $node['answertest'] : self::split_answertest(self::get_default('node', 'answertest'))[0];
                         $diffsans = isset($node['sans']) ? $node['sans'] : self::get_default('node', 'sans');
                         $difftans = isset($node['tans']) ? $node['tans'] : self::get_default('node', 'tans');
-                        $difftestoptions = isset($node->testoptions) ?
-                            $node->testoptions : self::get_default('node', 'testoptions');
+                        $difftestoptions = isset($node['testoptions']) ?
+                            $node['testoptions'] : self::get_default('node', 'testoptions');
                         $diffnode['answertest'] =
-                            "{$diffanswertest}({$diffsans},{$difftans}" . ($difftestoptions !== '' ? ",{$difftestoptions}" : '') . ')';
+                            "{$diffanswertest}({$diffsans},{$difftans}" .
+                            ($difftestoptions !== '' ? ",{$difftestoptions}" : '') . ')';
                         unset($diffnode['sans']);
                         unset($diffnode['tans']);
                         unset($diffnode['testoptions']);
@@ -704,19 +710,19 @@ public static function split_answertest($answertest) {
         $firstbracketpos = strpos($answertest, '(');
         $result[] = substr($answertest, 0, $firstbracketpos);
         $testprops = substr($answertest, $firstbracketpos + 1, strrpos($answertest, ')') - $firstbracketpos - 1);
-        $bracket_level = 0;
+        $bracketlevel = 0;
         $current = '';
         $count = 0;
         $len = strlen($testprops);
         for ($i = 0; $i < $len; $i++) {
             $char = $testprops[$i];
             if ($char === '(') {
-                $bracket_level++;
+                $bracketlevel++;
                 $current .= $char;
             } else if ($char === ')') {
-                $bracket_level--;
+                $bracketlevel--;
                 $current .= $char;
-            } else if ($char === ',' && $bracket_level === 0 && $count < 2) {
+            } else if ($char === ',' && $bracketlevel === 0 && $count < 2) {
                 $result[] = trim($current);
                 $current = '';
                 $count++;
@@ -725,7 +731,7 @@ public static function split_answertest($answertest) {
             }
         }
         $result[] = trim($current);
-        // Ensure always 4 items
+        // Ensure always 4 items.
         while (count($result) < 4) {
             $result[] = '';
         }
diff --git a/doc/useyaml.md b/doc/useyaml.md
@@ -52,6 +52,21 @@ specificfeedbackformat: html
 
 See [test question](../tests/fixtures/fullquestion.yml) for sample YAML layout.
 
+Additionally you can set your default file so that the answer tests for your questions are stored
+in a summary format:
+```
+ATanswertest(sans,tans,testoptions)
+```
+Default file example:
+```
+  answertest: ATAlgEquiv(ans1,ta1)
+  # sans, tans, testoptions will not be used but need to be here for diff compatibility
+  # with questions which have them rather than the summary answertest.
+  sans:
+  tans:
+  testoptions:
+```
+
 When importing to Moodle, Gitsync adds all the missing fields to the YAML representation from the defaults file, converts it to XML, creates a temporary XML file in the repo directory and then uploads this to Moodle. The defaults file is selected in the same way as for export so you can use different defaults if required.
 
 Obviously, using different defaults for import and export should be handled with care to avoid information loss! It makes most sense for altering site-specific settings that will be the same for every question e.g. decimal separator. Normally Gitsync skips importing questions that have not changed in the repo since the last import so if you want to update them using different defaults you will need to use `-z` to force import of questions that have not changed themselves.
diff --git a/tests/fixtures/fullquestionsummary.yml b/tests/fixtures/fullquestionsummary.yml
@@ -0,0 +1,147 @@
+name: Test question
+questiontext: |
+    <p>Question</p><p>[[input:ans1]] [[validation:ans1]]</p>
+        <p>[[input:ans2]] [[validation:ans2]]</p>
+questiontextformat: html
+generalfeedback:
+generalfeedbackformat: html
+defaultgrade: 1
+penalty: 0.1
+hidden: 0
+idnumber:
+stackversion: 2025042500
+questionvariables: ta1:1;ta2:2;
+specificfeedback: <p>[[feedback:prt1]]</p>
+specificfeedbackformat: html
+questionnote: <p>{@ta1@}</p>
+questionnoteformat: html
+questiondescription:
+questiondescriptionformat: html
+questionsimplify: 1
+assumepositive: 0
+assumereal: 0
+prtcorrect: <p><i class="fa fa-check"></i> Correct answer*, well done.</p>
+prtcorrectformat: html
+prtpartiallycorrect: <p><i class="fa fa-adjust"></i> Your answer is partially correct.</p>
+prtpartiallycorrectformat: html
+prtincorrect: <p><i class="fa fa-times"></i> Incorrect answer.</p>
+prtincorrectformat: html
+decimals: .
+scientificnotation: '*10'
+multiplicationsign: cross
+sqrtsign: 1
+complexno: i
+inversetrig: cos-1
+logicsymbol: lang
+matrixparens: '['
+isbroken: 0
+variantsselectionseed:
+deployedseed:
+  - 1
+  - 2
+  - 3
+input:
+  - name: ans1
+    type: algebraic
+    tans: ta1
+    boxsize: 25
+    strictsyntax: 1
+    insertstars: 0
+    syntaxhint:
+    syntaxattribute: 0
+    forbidwords:
+    allowwords:
+    forbidfloat: 1
+    requirelowestterms: 0
+    checkanswertype: 0
+    mustverify: 1
+    showvalidation: 1
+    options:
+  - name: ans2
+    type: algebraic
+    tans: ta2
+    boxsize: 15
+    strictsyntax: 1
+    insertstars: 0
+    syntaxhint:
+    syntaxattribute: 0
+    forbidwords:
+    allowwords:
+    forbidfloat: 1
+    requirelowestterms: 0
+    checkanswertype: 0
+    mustverify: 1
+    showvalidation: 1
+    options:
+prt:
+  - name: prt1
+    value: 2.0000000
+    autosimplify: 1
+    feedbackstyle: 1
+    feedbackvariables:
+    node:
+      - name: 0
+        description:
+        answertest: Diff
+        sans: ans1
+        tans: diff(p,v)
+        testoptions: v
+        quiet: 1
+        truescoremode: =
+        truescore: 1
+        truepenalty:
+        truenextnode: -1
+        trueanswernote: prt1-1-T
+        truefeedback:
+        truefeedbackformat: html
+        falsescoremode: =
+        falsescore: 0
+        falsepenalty:
+        falsenextnode: -1
+        falseanswernote: prt1-1-F
+        falsefeedback:
+        falsefeedbackformat: html
+  - name: prt2
+    value: 1.0000001
+    autosimplify: 1
+    feedbackstyle: 1
+    feedbackvariables:
+    node:
+      - name: 0
+        description:
+        answertest: AlgEquiv
+        sans: ans2
+        tans: -rdm*sin(v)
+        testoptions:
+        quiet: 0
+        truescoremode: =
+        truescore: 1
+        truepenalty:
+        truenextnode: -1
+        trueanswernote: prt1-1-T
+        truefeedback:
+        truefeedbackformat: html
+        falsescoremode: =
+        falsescore: 1
+        falsepenalty:
+        falsenextnode: -1
+        falseanswernote: prt1-1-F
+        falsefeedback:
+        falsefeedbackformat: html
+qtest:
+  - testcase: '1'
+    description: 'A test'
+    testinput:
+      - name: 'ans1'
+        value: 'ta1'
+      - name: 'ans2'
+        value: 'ta2'
+    expected:
+      - name: 'prt1'
+        expectedscore: '1.0000000'
+        expectedpenalty: '0.0000000'
+        expectedanswernote: '1-0-T'
+      - name: 'prt2'
+        expectedscore: '1.0000000'
+        expectedpenalty: '0.0000000'
+        expectedanswernote: '2-0-T'
diff --git a/tests/yaml_converter_test.php b/tests/yaml_converter_test.php
@@ -190,6 +190,72 @@ public function test_loadxml(): void {
         $this->assertEquals('2-0-T', (string) $qtest->expected[1]->expectedanswernote);
     }
 
+    public function test_loadxml_summary_default(): void {
+        if (!defined('Symfony\Component\Yaml\Yaml::DUMP_COMPACT_NESTED_MAPPING')) {
+            $this->markTestSkipped('Symfony YAML extension is not available.');
+            return;
+        }
+        $defaults = Yaml::parseFile(__DIR__ . '/fixtures/questiondefaultssugar.yml');
+        $questionyaml = file_get_contents(__DIR__ . '/fixtures/fullquestion.yml');
+        $xml = \qbank_gitsync\yaml_converter::loadyaml($questionyaml , $defaults);
+
+        // Check prt fields.
+        $this->assertCount(2, $xml->question->prt);
+        $prt1 = $xml->question->prt[0];
+        $prt2 = $xml->question->prt[1];
+        $this->assertCount(1, $prt1->node);
+        $this->assertEquals('0', (string) $prt1->node[0]->name);
+        $this->assertEquals('', (string) $prt1->node[0]->description);
+        $this->assertEquals('AlgEquiv', (string) $prt1->node[0]->answertest);
+        $this->assertEquals('ans1', (string) $prt1->node[0]->sans);
+        $this->assertEquals('ta1', (string) $prt1->node[0]->tans);
+        $this->assertEquals('', (string) $prt1->node[0]->testoptions);
+        $this->assertEquals('1', (string) $prt1->node[0]->quiet);
+        $this->assertEquals('=', (string) $prt1->node[0]->truescoremode);
+
+        $this->assertCount(1, $prt2->node);
+        $this->assertEquals('0', (string) $prt2->node[0]->name);
+        $this->assertEquals('AlgEquiv', (string) $prt2->node[0]->answertest);
+        $this->assertEquals('ans2', (string) $prt2->node[0]->sans);
+        $this->assertEquals('ta2', (string) $prt2->node[0]->tans);
+        $this->assertEquals('0', (string) $prt2->node[0]->quiet);
+        $this->assertEquals('1', (string) $prt2->node[0]->falsescore);
+    }
+
+
+    public function test_loadxml_summary(): void {
+        if (!defined('Symfony\Component\Yaml\Yaml::DUMP_COMPACT_NESTED_MAPPING')) {
+            $this->markTestSkipped('Symfony YAML extension is not available.');
+            return;
+        }
+        $defaults = Yaml::parseFile(__DIR__ . '/fixtures/questiondefaultssugar.yml');
+        $questionyaml = file_get_contents(__DIR__ . '/fixtures/fullquestionsummary.yml');
+        $xml = \qbank_gitsync\yaml_converter::loadyaml($questionyaml , $defaults);
+
+        // Check prt fields.
+        $this->assertCount(2, $xml->question->prt);
+        $prt1 = $xml->question->prt[0];
+        $prt2 = $xml->question->prt[1];
+        $this->assertCount(1, $prt1->node);
+        $this->assertEquals('0', (string) $prt1->node[0]->name);
+        $this->assertEquals('', (string) $prt1->node[0]->description);
+        $this->assertEquals('Diff', (string) $prt1->node[0]->answertest);
+        $this->assertEquals('ans1', (string) $prt1->node[0]->sans);
+        $this->assertEquals('diff(p,v)', (string) $prt1->node[0]->tans);
+        $this->assertEquals('v', (string) $prt1->node[0]->testoptions);
+        $this->assertEquals('1', (string) $prt1->node[0]->quiet);
+        $this->assertEquals('=', (string) $prt1->node[0]->truescoremode);
+
+        $this->assertCount(1, $prt2->node);
+        $this->assertEquals('0', (string) $prt2->node[0]->name);
+        $this->assertEquals('AlgEquiv', (string) $prt2->node[0]->answertest);
+        $this->assertEquals('ans2', (string) $prt2->node[0]->sans);
+        $this->assertEquals('-rdm*sin(v)', (string) $prt2->node[0]->tans);
+        $this->assertEquals('', (string) $prt2->node[0]->testoptions);
+        $this->assertEquals('0', (string) $prt2->node[0]->quiet);
+        $this->assertEquals('1', (string) $prt2->node[0]->falsescore);
+    }
+
     public function test_yaml_to_xml(): void {
         if (!defined('Symfony\Component\Yaml\Yaml::DUMP_COMPACT_NESTED_MAPPING')) {
             $this->markTestSkipped('Symfony YAML extension is not available.');
@@ -520,57 +586,57 @@ public function test_detect_difference_yml(): void {
         $this->assertEqualsCanonicalizing($expected, $diffarray);
     }
 
-    public function test_split_answertest_basic() {
+    public function test_split_answertest_basic(): void {
         $input = 'ATAlgEquiv(x^2+2x+1, (x+1)^2, 1, ignoreorder)';
         $expected = [
             'ATAlgEquiv',
             'x^2+2x+1',
             '(x+1)^2',
-            '1, ignoreorder'
+            '1, ignoreorder',
         ];
         $this->assertEquals($expected, yaml_converter::split_answertest($input));
     }
 
-    public function test_split_answertest_nested_parentheses() {
+    public function test_split_answertest_nested_parentheses(): void {
         $input = 'ATTest(foo(bar, baz), qux, quux, corge)';
         $expected = [
             'ATTest',
             'foo(bar, baz)',
             'qux',
-            'quux, corge'
+            'quux, corge',
         ];
         $this->assertEquals($expected, yaml_converter::split_answertest($input));
     }
 
-    public function test_split_answertest_missing_items() {
+    public function test_split_answertest_missing_items(): void {
         $input = 'ATTest(foo)';
         $expected = [
             'ATTest',
             'foo',
             '',
-            ''
+            '',
         ];
         $this->assertEquals($expected, yaml_converter::split_answertest($input));
     }
 
-    public function test_split_answertest_extra_commas() {
+    public function test_split_answertest_extra_commas(): void {
         $input = 'ATTest(foo, bar, baz, qux, quux)';
         $expected = [
             'ATTest',
             'foo',
             'bar',
-            'baz, qux, quux'
+            'baz, qux, quux',
         ];
         $this->assertEquals($expected, yaml_converter::split_answertest($input));
     }
 
-    public function test_split_answertest_spaces() {
+    public function test_split_answertest_spaces(): void {
         $input = 'ATTest( foo ( bar ), baz , qux )';
         $expected = [
             'ATTest',
             'foo ( bar )',
             'baz',
-            'qux'
+            'qux',
         ];
         $this->assertEquals($expected, yaml_converter::split_answertest($input));
     }
