vanitasvitae/Smack
1
0
Fork 0
mirror of https://github.com/vanitasvitae/Smack.git synced 2025-12-13 06:21:08 +01:00
Code Issues Releases Wiki Activity

Re-work data form API

Browse source 
Apply builder pattern to form fields and replace getVariable() with
getFieldName(). Refer to the field name as "field name" instead of
"variable" everyone, just as XEP-0004 does.

Improve the high-level form API: introduce FilledForm and FillableForm
which perform stronger validation and consistency checks.

Also add FormFieldRegistry to enable processing of 'submit' forms
where the form field types are omitted.

Smack also now does omit the form field type declaration on 'submit'
type forms, as it is allowed by XEP-0004.
This commit is contained in:
Florian Schmaus 2020-05-13 20:14:41 +02:00
parent 3270c113c5
commit 77e26fc575
97 changed files with 3809 additions and 2427 deletions
Download patch file Download diff file Expand all files Collapse all files

38
smack-extensions/src/test/java/org/jivesoftware/smackx/xdata/FormFieldTest.java Normal file
View file

@ -0,0 +1,38 @@
/**
*
* Copyright 2020 Florian Schmaus.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.jivesoftware.smackx.xdata;
import static org.jivesoftware.smack.test.util.XmlUnitUtils.assertXmlSimilar;
import org.junit.jupiter.api.Test;
import org.jxmpp.jid.JidTestUtil;
class FormFieldTest {
@Test
public void testJidMultiToXml() {
JidMultiFormField jidMultiFormField = FormField.jidMultiBuilder("myfield")
.addValue(JidTestUtil.BARE_JID_1)
.addValue(JidTestUtil.BARE_JID_2)
.build();
String expectedXml = "<field xmlns='jabber:x:data' var='myfield' type='jid-multi'><value>one@exampleone.org</value><value>one@exampletwo.org</value></field>";
CharSequence xml = jidMultiFormField.toXML();
assertXmlSimilar(expectedXml, xml);
}
}

66
smack-extensions/src/test/java/org/jivesoftware/smackx/xdata/packet/DataFormTest.java
View file

@ -43,43 +43,42 @@ import org.junit.jupiter.api.Test;
*
*/
public class DataFormTest extends SmackTestSuite {
private static final String TEST_OUTPUT_1 = "<x xmlns='jabber:x:data' type='submit'><instructions>InstructionTest1</instructions><field var='testField1'/></x>";
private static final String TEST_OUTPUT_2 = "<x xmlns='jabber:x:data' type='submit'><instructions>InstructionTest1</instructions><field var='testField1'/><page xmlns='http://jabber.org/protocol/xdata-layout' label='Label'><fieldref var='testField1'/><section label='section Label'><text>SectionText</text></section><text>PageText</text></page></x>";
private static final String TEST_OUTPUT_3 = "<x xmlns='jabber:x:data' type='submit'><instructions>InstructionTest1</instructions><field var='testField1'><validate xmlns='http://jabber.org/protocol/xdata-validate' datatype='xs:integer'><range min='1111' max='9999'/></validate></field></x>";
private static final String TEST_OUTPUT_1 = "<x xmlns='jabber:x:data' type='form'><instructions>InstructionTest1</instructions><field var='testField1'/></x>";
private static final String TEST_OUTPUT_2 = "<x xmlns='jabber:x:data' type='form'><instructions>InstructionTest1</instructions><field var='testField1'/><page xmlns='http://jabber.org/protocol/xdata-layout' label='Label'><fieldref var='testField1'/><section label='section Label'><text>SectionText</text></section><text>PageText</text></page></x>";
private static final String TEST_OUTPUT_3 = "<x xmlns='jabber:x:data' type='form'><instructions>InstructionTest1</instructions><field var='testField1'><validate xmlns='http://jabber.org/protocol/xdata-validate' datatype='xs:integer'><range min='1111' max='9999'/></validate></field></x>";
private static final DataFormProvider pr = new DataFormProvider();
@Test
public void test() throws Exception {
// Build a Form.
DataForm df = new DataForm(DataForm.Type.submit);
DataForm.Builder df = DataForm.builder(DataForm.Type.form);
String instruction = "InstructionTest1";
df.addInstruction(instruction);
FormField field = FormField.builder("testField1").build();
df.addField(field);
assertNotNull(df.toXML());
String output = df.toXML().toString();
DataForm dataForm = df.build();
String output = dataForm.toXML().toString();
assertEquals(TEST_OUTPUT_1, output);
XmlPullParser parser = PacketParserUtils.getParserFor(output);
df = pr.parse(parser);
dataForm = pr.parse(parser);
assertNotNull(df);
assertNotNull(df.getFields());
assertEquals(1 , df.getFields().size());
assertEquals(1 , df.getInstructions().size());
assertNotNull(dataForm);
assertNotNull(dataForm.getFields());
assertEquals(1 , dataForm.getFields().size());
assertEquals(1 , dataForm.getInstructions().size());
assertNotNull(df.toXML());
output = df.toXML().toString();
output = dataForm.toXML().toString();
assertEquals(TEST_OUTPUT_1, output);
}
@Test
public void testLayout() throws Exception {
// Build a Form.
DataForm df = new DataForm(DataForm.Type.submit);
DataForm.Builder df = DataForm.builder(DataForm.Type.form);
String instruction = "InstructionTest1";
df.addInstruction(instruction);
FormField field = FormField.builder("testField1").build();
@ -95,67 +94,62 @@ public class DataFormTest extends SmackTestSuite {
df.addExtensionElement(layout);
assertNotNull(df.toXML());
String output = df.toXML().toString();
DataForm dataForm = df.build();
String output = dataForm.toXML().toString();
assertEquals(TEST_OUTPUT_2, output);
XmlPullParser parser = PacketParserUtils.getParserFor(output);
df = pr.parse(parser);
dataForm = pr.parse(parser);
assertNotNull(df);
assertNotNull(df.getExtensionElements());
assertEquals(1 , df.getExtensionElements().size());
Element element = df.getExtensionElements().get(0);
assertNotNull(dataForm.getExtensionElements());
assertEquals(1 , dataForm.getExtensionElements().size());
Element element = dataForm.getExtensionElements().get(0);
assertNotNull(element);
layout = (DataLayout) element;
assertEquals(3 , layout.getPageLayout().size());
assertNotNull(df.toXML());
output = df.toXML().toString();
output = dataForm.toXML().toString();
assertEquals(TEST_OUTPUT_2, output);
}
@Test
public void testValidation() throws Exception {
// Build a Form.
DataForm df = new DataForm(DataForm.Type.submit);
DataForm.Builder df = DataForm.builder(DataForm.Type.form);
String instruction = "InstructionTest1";
df.addInstruction(instruction);
FormField.Builder fieldBuilder = FormField.builder("testField1");
FormField.Builder<?, ?> fieldBuilder = FormField.builder("testField1");
ValidateElement dv = new RangeValidateElement("xs:integer", "1111", "9999");
fieldBuilder.addFormFieldChildElement(dv);
df.addField(fieldBuilder.build());
assertNotNull(df.toXML());
String output = df.toXML().toString();
DataForm dataForm = df.build();
String output = dataForm.toXML().toString();
assertEquals(TEST_OUTPUT_3, output);
XmlPullParser parser = PacketParserUtils.getParserFor(output);
df = pr.parse(parser);
dataForm = pr.parse(parser);
assertNotNull(df);
assertNotNull(df.getFields());
assertEquals(1 , df.getFields().size());
Element element = ValidateElement.from(df.getFields().get(0));
assertNotNull(dataForm.getFields());
assertEquals(1 , dataForm.getFields().size());
Element element = ValidateElement.from(dataForm.getFields().get(0));
assertNotNull(element);
dv = (ValidateElement) element;
assertEquals("xs:integer" , dv.getDatatype());
assertNotNull(df.toXML());
output = df.toXML().toString();
output = dataForm.toXML().toString();
assertEquals(TEST_OUTPUT_3, output);
}
@Test
public void testFixedField() throws Exception {
final String formWithFixedField = "<x xmlns='jabber:x:data' type='submit'><instructions>InstructionTest1</instructions><field type='fixed'></field></x>";
final String formWithFixedField = "<x xmlns='jabber:x:data' type='form'><instructions>InstructionTest1</instructions><field type='fixed'><value>Fixed field value</value></field></x>";
DataForm df = pr.parse(PacketParserUtils.getParserFor(formWithFixedField));
assertEquals(Type.fixed, df.getFields().get(0).getType());
}